Struct SDL_GPUTextureTransferInfo 

#[repr(C)]
pub struct SDL_GPUTextureTransferInfo {
    pub transfer_buffer: *mut SDL_GPUTransferBuffer,
    pub offset: Uint32,
    pub pixels_per_row: Uint32,
    pub rows_per_layer: Uint32,
}

A structure specifying parameters related to transferring data to or from a texture.

If either of pixels_per_row or rows_per_layer is zero, then width and height of passed SDL_GPUTextureRegion to SDL_UploadToGPUTexture or SDL_DownloadFromGPUTexture are used as default values respectively and data is considered to be tightly packed.

WARNING: Direct3D 12 requires texture data row pitch to be 256 byte aligned, and offsets to be aligned to 512 bytes. If they are not, SDL will make a temporary copy of the data that is properly aligned, but this adds overhead to the transfer process. Apps can avoid this by aligning their data appropriately, or using a different GPU backend than Direct3D 12.

Availability

This struct is available since SDL 3.2.0.

See also

• SDL_UploadToGPUTexture
• SDL_DownloadFromGPUTexture

Fields

transfer_buffer: *mut SDL_GPUTransferBuffer

The transfer buffer used in the transfer operation.

offset: Uint32

The starting byte of the image data in the transfer buffer.

pixels_per_row: Uint32

The number of pixels from one row to the next.

rows_per_layer: Uint32

The number of rows from one layer/depth-slice to the next.

Trait Implementations

impl Clone for SDL_GPUTextureTransferInfo

fn clone(&self) -> SDL_GPUTextureTransferInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SDL_GPUTextureTransferInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SDL_GPUTextureTransferInfo

fn default() -> Self

Initialize all fields to zero

impl Copy for SDL_GPUTextureTransferInfo