RequestIntoNativeSliceAsync
Retrieves data asynchronously from a GPU Graphics Buffer resource.
Read time 6 minutesLast updated 10 days ago
Definition
- Type: Method
- Namespace: UnityEngine.Rendering
- Assembly: UnityEngine.CoreModule
RequestIntoNativeSliceAsync<T>(NativeSlice<T>, ComputeBuffer)
Retrieves data asynchronously from a GPU Graphics Buffer resource.
public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync<T>(ref NativeSlice<T> output, ComputeBuffer src) where T : struct
Parameters
Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete.
The GraphicsBuffer to read the data from.
Returns
Type | Description |
|---|---|
| Awaitable<AsyncGPUReadbackRequest> |
Remarks
RequestIntoNativeSliceAsync<T>(NativeSlice<T>, ComputeBuffer, int, int)
Retrieves data asynchronously from a GPU Graphics Buffer resource.
public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync<T>(ref NativeSlice<T> output, ComputeBuffer src, int size, int offset) where T : struct
Parameters
Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete.
The GraphicsBuffer to read the data from.
The size, in bytes, of the data to retrieve from the GraphicsBuffer.
Offset in bytes in the GraphicsBuffer.
Returns
Type | Description |
|---|---|
| Awaitable<AsyncGPUReadbackRequest> |
Remarks
RequestIntoNativeSliceAsync<T>(NativeSlice<T>, GraphicsBuffer)
Retrieves data asynchronously from a GPU Graphics Buffer resource.
public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync<T>(ref NativeSlice<T> output, GraphicsBuffer src) where T : struct
Parameters
Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete.
The GraphicsBuffer to read the data from.
Returns
Type | Description |
|---|---|
| Awaitable<AsyncGPUReadbackRequest> |
Remarks
RequestIntoNativeSliceAsync<T>(NativeSlice<T>, GraphicsBuffer, int, int)
Retrieves data asynchronously from a GPU Graphics Buffer resource.
public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync<T>(ref NativeSlice<T> output, GraphicsBuffer src, int size, int offset) where T : struct
Parameters
Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete.
The GraphicsBuffer to read the data from.
The size, in bytes, of the data to retrieve from the GraphicsBuffer.
Offset in bytes in the GraphicsBuffer.
Returns
Type | Description |
|---|---|
| Awaitable<AsyncGPUReadbackRequest> |
Remarks
RequestIntoNativeSliceAsync<T>(NativeSlice<T>, Texture, int)
Retrieves data asynchronously from a GPU Texture resource.
public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync<T>(ref NativeSlice<T> output, Texture src, int mipIndex = 0) where T : struct
Parameters
Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete.
The index of the mipmap to fetch.
Returns
Type | Description |
|---|---|
| Awaitable<AsyncGPUReadbackRequest> |
Remarks
RequestIntoNativeSliceAsync<T>(NativeSlice<T>, Texture, int, TextureFormat)
Retrieves data asynchronously from a GPU Texture resource.
public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync<T>(ref NativeSlice<T> output, Texture src, int mipIndex, TextureFormat dstFormat) where T : struct
Parameters
Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete.
The index of the mipmap to fetch.
The target TextureFormat of the data. Conversion happens automatically if this format is different from the format stored on the GPU.
Returns
Type | Description |
|---|---|
| Awaitable<AsyncGPUReadbackRequest> |
Remarks
RequestIntoNativeSliceAsync<T>(NativeSlice<T>, Texture, int, GraphicsFormat)
Retrieves data asynchronously from a GPU Texture resource.
public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync<T>(ref NativeSlice<T> output, Texture src, int mipIndex, GraphicsFormat dstFormat) where T : struct
Parameters
Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete.
The index of the mipmap to fetch.
The target TextureFormat of the data. Conversion happens automatically if this format is different from the format stored on the GPU.
Returns
Type | Description |
|---|---|
| Awaitable<AsyncGPUReadbackRequest> |
Remarks
RequestIntoNativeSliceAsync<T>(NativeSlice<T>, Texture, int, int, int, int, int, int, int, TextureFormat)
Retrieves data asynchronously from a GPU Texture resource.
public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync<T>(ref NativeSlice<T> output, Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, TextureFormat dstFormat) where T : struct
Parameters
Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete.
The index of the mipmap to fetch.
The starting x-coordinate, in pixels, of the Texture data to fetch.
The width, in pixels, of the Texture data to fetch.
The starting y-coordinate, in pixels, of the Texture data to fetch.
The height, in pixels, of the Texture data to fetch.
The starting z-coordinate, in pixels, of the Texture3D to fetch. For TextureCube, Texture2DArray, and TextureCubeArray, this is the index of the start layer.
The depth, in pixels of the Texture3D to fetch. For TextureCube, Texture2DArray, and TextureCubeArray, this is the number of layers to retrieve.
The target TextureFormat of the data. Conversion happens automatically if this format is different from the format stored on the GPU.
Returns
Type | Description |
|---|---|
| Awaitable<AsyncGPUReadbackRequest> |
Remarks
RequestIntoNativeSliceAsync<T>(NativeSlice<T>, Texture, int, int, int, int, int, int, int, GraphicsFormat)
Retrieves data asynchronously from a GPU Texture resource.
public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync<T>(ref NativeSlice<T> output, Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, GraphicsFormat dstFormat) where T : struct
Parameters
Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete.
The index of the mipmap to fetch.
The starting x-coordinate, in pixels, of the Texture data to fetch.
The width, in pixels, of the Texture data to fetch.
The starting y-coordinate, in pixels, of the Texture data to fetch.
The height, in pixels, of the Texture data to fetch.
The starting z-coordinate, in pixels, of the Texture3D to fetch. For TextureCube, Texture2DArray, and TextureCubeArray, this is the index of the start layer.
The depth, in pixels of the Texture3D to fetch. For TextureCube, Texture2DArray, and TextureCubeArray, this is the number of layers to retrieve.
The target TextureFormat of the data. Conversion happens automatically if this format is different from the format stored on the GPU.
Returns
Type | Description |
|---|---|
| Awaitable<AsyncGPUReadbackRequest> |