class IFrameBufferOutput;

The IFrameBufferOutput interface represents an object which is capable of retrieving the output of a single framebuffer target, such as a colour, depth, or stencil buffer, and returning the contained data to the application. This is useful for creating screenshots, or potentially for recording a video of every rendered frame produced. Multiple IFrameBufferOutput objects can be attached to the one IFrameBuffer, to capture multiple output targets, or potentially to capture the same output target into multiple IFrameBufferOutput objects. It is also possible to attach an IFrameBufferOutput object to intermediate framebuffers, which aren't displayed directly to the screen, but are used to write to textures that are fed into later stages of rendering. This can be useful for debugging issues during development.

Initialization methods

	Name	Description
	Delete	Schedules the object for deletion. After calling this method, the object will be destroyed after the current frame completes drawing.

Configuration methods

	Name	Description
	SetDetachAfterCapture	Specifies whether this IFrameBufferOutput object will be detached after capturing a single image.
	SetFrameBufferCaptureRegion	Specifies the region of the bound framebuffer image to capture

Data methods

	Name	Description
	HasCapturedOutput	Returns true if there is image data ready to be read from the output buffer
	ClearCapturedOutput	Relases the captured image data. Note that this doesn't need to be called to capture a new frame.
	GetImageDimensions	Returns the size in pixels of the image data in the output buffer
	GetCroppedImageDimensions	Returns the resulting image size if the specified offset and maximum region size are applied to the actual image data in the output buffer. This can be used to appropriately size a buffer to pass into the ReadBufferData method.
	GetOptimalImageFormat	Returns the SourceImageFormat that most closely matches the format of the captured image data.
	GetOptimalDataFormat	Returns the SourceDataFormat that most closely matches the format of the captured image data.
	ReadBufferData	Attempts to read the requested portion of the captured image output and write it to the target buffer

• IFrameBuffer