Package apple.metal.protocol

Interface MTLResourceStateCommandEncoder

All Superinterfaces:

MTLCommandEncoder

public interface MTLResourceStateCommandEncoder
extends MTLCommandEncoder

API-Since: 13.0

Method Summary

Modifier and Type	Method	Description
void	moveTextureMappingsFromTextureSourceSliceSourceLevelSourceOriginSourceSizeToTextureDestinationSliceDestinationLevelDestinationOrigin(@NotNull MTLTexture sourceTexture, long sourceSlice, long sourceLevel, MTLOrigin sourceOrigin, MTLSize sourceSize, @NotNull MTLTexture destinationTexture, long destinationSlice, long destinationLevel, MTLOrigin destinationOrigin)	moveTextureMappingsFromTexture:sourceSlice:sourceLevel:sourceOrigin:sourceSize:toTexture:destinationSlice:destinationLevel:destinationOrigin: Move sparse page mappings from one sparse texture to another from the same heap.
void	updateFence(@NotNull MTLFence fence)	updateFence: Update the fence to capture all GPU work so far enqueued by this encoder.
void	updateTextureMappingModeIndirectBufferIndirectBufferOffset(@NotNull MTLTexture texture, long mode, @NotNull MTLBuffer indirectBuffer, long indirectBufferOffset)	updateTextureMapping:indirectBuffer:indirectBufferOffset: Updates mapping for given sparse texture.
void	updateTextureMappingModeRegionMipLevelSlice(@NotNull MTLTexture texture, long mode, MTLRegion region, long mipLevel, long slice)	updateTextureMapping:region:mipLevel:slice:mode: Updates mapping for given sparse texture API-Since: 13.0
void	updateTextureMappingsModeRegionsMipLevelsSlicesNumRegions(@NotNull MTLTexture texture, long mode, @NotNull MTLRegion regions, @NotNull org.moe.natj.general.ptr.ConstNUIntPtr mipLevels, @NotNull org.moe.natj.general.ptr.ConstNUIntPtr slices, long numRegions)	updateTextureMappings:regions:mipLevels:slices:numRegions:mode: Updates multiple regions within a sparse texture.
void	waitForFence(@NotNull MTLFence fence)	waitForFence: Prevent further GPU work until the fence is reached.

Methods inherited from interface apple.metal.protocol.MTLCommandEncoder

device, endEncoding, insertDebugSignpost, label, popDebugGroup, pushDebugGroup, setLabel

Method Detail

updateFence

void updateFence(@NotNull
                 @NotNull MTLFence fence)

updateFence: Update the fence to capture all GPU work so far enqueued by this encoder. The fence is updated at kernel submission to maintain global order and prevent deadlock. Drivers may delay fence updates until the end of the encoder. Drivers may also wait on fences at the beginning of an encoder. It is therefore illegal to wait on a fence after it has been updated in the same encoder. API-Since: 13.0

updateTextureMappingModeIndirectBufferIndirectBufferOffset

void updateTextureMappingModeIndirectBufferIndirectBufferOffset(@NotNull
                                                                @NotNull MTLTexture texture,
                                                                long mode,
                                                                @NotNull
                                                                @NotNull MTLBuffer indirectBuffer,
                                                                long indirectBufferOffset)

updateTextureMapping:indirectBuffer:indirectBufferOffset: Updates mapping for given sparse texture. Updates are driven via a MTLBuffer with the structure format defined by MTLMapIndirectBufferFormat. struct MTLMapIndirectBufferFormat{ uint32_t numMappings; MTLMapIndirectArguments mappings[numMappings]; } API-Since: 13.0

updateTextureMappingModeRegionMipLevelSlice

void updateTextureMappingModeRegionMipLevelSlice(@NotNull
                                                 @NotNull MTLTexture texture,
                                                 long mode,
                                                 MTLRegion region,
                                                 long mipLevel,
                                                 long slice)

updateTextureMapping:region:mipLevel:slice:mode: Updates mapping for given sparse texture API-Since: 13.0

updateTextureMappingsModeRegionsMipLevelsSlicesNumRegions

void updateTextureMappingsModeRegionsMipLevelsSlicesNumRegions(@NotNull
                                                               @NotNull MTLTexture texture,
                                                               long mode,
                                                               @NotNull
                                                               @NotNull MTLRegion regions,
                                                               @NotNull
                                                               @NotNull org.moe.natj.general.ptr.ConstNUIntPtr mipLevels,
                                                               @NotNull
                                                               @NotNull org.moe.natj.general.ptr.ConstNUIntPtr slices,
                                                               long numRegions)

updateTextureMappings:regions:mipLevels:slices:numRegions:mode: Updates multiple regions within a sparse texture. API-Since: 13.0

waitForFence

void waitForFence(@NotNull
                  @NotNull MTLFence fence)

waitForFence: Prevent further GPU work until the fence is reached. The fence is evaluated at kernel submission to maintain global order and prevent deadlock. Drivers may delay fence updates until the end of the encoder. Drivers may also wait on fences at the beginning of an encoder. It is therefore illegal to wait on a fence after it has been updated in the same encoder. API-Since: 13.0

moveTextureMappingsFromTextureSourceSliceSourceLevelSourceOriginSourceSizeToTextureDestinationSliceDestinationLevelDestinationOrigin

void moveTextureMappingsFromTextureSourceSliceSourceLevelSourceOriginSourceSizeToTextureDestinationSliceDestinationLevelDestinationOrigin(@NotNull
                                                                                                                                          @NotNull MTLTexture sourceTexture,
                                                                                                                                          long sourceSlice,
                                                                                                                                          long sourceLevel,
                                                                                                                                          MTLOrigin sourceOrigin,
                                                                                                                                          MTLSize sourceSize,
                                                                                                                                          @NotNull
                                                                                                                                          @NotNull MTLTexture destinationTexture,
                                                                                                                                          long destinationSlice,
                                                                                                                                          long destinationLevel,
                                                                                                                                          MTLOrigin destinationOrigin)

moveTextureMappingsFromTexture:sourceSlice:sourceLevel:sourceOrigin:sourceSize:toTexture:destinationSlice:destinationLevel:destinationOrigin: Move sparse page mappings from one sparse texture to another from the same heap. The tile mapping is moved from the source texture only if the destination texture tile is unmapped. The textures must also have matching a texture format, texture type, sample count, usage and resource options. API-Since: 16.0