Struct MTL4UpdateSparseTextureMappingOperation 

#[repr(C)]
pub struct MTL4UpdateSparseTextureMappingOperation {
    pub mode: MTLSparseTextureMappingMode,
    pub textureRegion: MTLRegion,
    pub textureLevel: NSUInteger,
    pub textureSlice: NSUInteger,
    pub heapOffset: NSUInteger,
}

Available on crate features MTL4CommandQueue and MTLResourceStateCommandEncoder and MTLTypes only.

Groups together arguments for an operation to update a sparse texture mapping.

When performing a sparse mapping update, you are responsible for issuing a barrier against stage MTLStageResourceState.

You can determine the sparse texture tier by calling MTLTexture/sparseTextureTier.

See also Apple’s documentation

Fields

mode: MTLSparseTextureMappingMode

The mode of the mapping operation to perform.

When mode is MTLSparseTextureMappingMode/MTLSparseTextureMappingModeMap, Metal walks the tiles in the region in X, Y, then Z order, assigning the next tile from the heap in increasing order, starting at heapOffset.

When mode is MTLSparseTextureMappingMode/MTLSparseTextureMappingModeUnmap, Metal unmaps the tiles in the region, ignoring the contents of member heapOffset.

textureRegion: MTLRegion

The region in the texture to update, in tiles.

When textureLevel is equal to the texture’s MTLTexture/firstMipmapInTail, set origin.y to 0 and size.height to 1.

textureLevel: NSUInteger

The index of the mipmap level in the texture to update.

Provide a value between 0 and the texture’s MTLTexture/firstMipmapInTail.

textureSlice: NSUInteger

The index of the array slice in the texture to update.

Provide 0 in this member if the texture type is not an array.

heapOffset: NSUInteger

The starting offset in the heap, in tiles.

Trait Implementations

impl Clone for MTL4UpdateSparseTextureMappingOperation

fn clone(&self) -> MTL4UpdateSparseTextureMappingOperation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MTL4UpdateSparseTextureMappingOperation

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

Formats the value using the given formatter.

impl Encode for MTL4UpdateSparseTextureMappingOperation

const ENCODING: Encoding

The Objective-C type-encoding for this type.

impl PartialEq for MTL4UpdateSparseTextureMappingOperation

fn eq(&self, other: &MTL4UpdateSparseTextureMappingOperation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for MTL4UpdateSparseTextureMappingOperation

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for MTL4UpdateSparseTextureMappingOperation

impl StructuralPartialEq for MTL4UpdateSparseTextureMappingOperation