Home -> ITexelArrayOutput
Declaration
class ITexelArrayOutput;Description
The ITexelArrayOutput interface represents an object which is capable of retrieving content from an ITexelArray, and returning the contained data to the application. This is useful when performing compute tasks in shaders, where the computed data needs to be returned to the application. Multiple ITexelArrayOutput objects can be attached to the one ITexelArray if required.
Important
Only the final state of the target ITexelArray can be captured, representing its content when the frame completes drawing. It is not possible to capture intermediate results from a buffer which are changed later in the same frame.
Members
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 ITexelArrayOutput object will be detached after a single frame.
|
|
SetArrayCaptureRegion |
Specifies the region of the bound texel array to capture
|
Data methods
| Name | Description | |
|---|---|---|
|
HasCapturedOutput |
Returns true if there is captured data ready to be read from the output buffer
|
|
ClearCapturedOutput |
Relases the captured data. Note that this doesn't need to be called to capture a new set of data.
|
|
GetEntryCount |
Returns the number of captured entries currently stored in the output buffer
|
|
GetOptimalImageFormat |
Returns the SourceImageFormat
that most closely matches the format of the captured texel data.
|
|
GetOptimalDataFormat |
Returns the SourceDataFormat
that most closely matches the format of the captured texel data.
|
|
ReadBufferData |
Attempts to read the requested portion of the captured output buffer and write it to the target buffer
|