Package apple.metal.protocol

Interface MTLIOCommandBuffer

  • public interface MTLIOCommandBuffer
    [@protocol] MTLIOCommandBuffer represents a list of IO commands for a queue to execute API-Since: 16.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addBarrier()
      addBarrier add a barrier that starts subsequent commands after all the previously encoded commands have completed.
      void addCompletedHandler​(@NotNull MTLIOCommandBuffer.Block_addCompletedHandler block)
      addCompletedHandler:block: Add a block to be called when this command buffer has completed execution.
      void commit()
      commit Commit a command buffer so it can be executed as soon as possible.
      void copyStatusToBufferOffset​(@NotNull MTLBuffer buffer, long offset)
      copyStatusToBuffer:buffer:offset Encodes a command that writes the status of this commandBuffer upon completion to a buffer at a given offset
      void enqueue()
      enqueue Append this command buffer to the end of its MTLCommandQueue.
      @Nullable NSError error()
      [@property] error If an error occurred during execution, the NSError may contain more details about the problem.
      @Nullable java.lang.String label()
      [@property] label An optional label for this handle.
      void loadBufferOffsetSizeSourceHandleSourceHandleOffset​(@NotNull MTLBuffer buffer, long offset, long size, @NotNull MTLIOFileHandle sourceHandle, long sourceHandleOffset)
      loadBuffer:offset:size:sourceHandle:sourceHandleOffset Encodes a command that loads from a handle and offset into a buffer and an offset.
      void loadBytesSizeSourceHandleSourceHandleOffset​(@NotNull org.moe.natj.general.ptr.VoidPtr pointer, long size, @NotNull MTLIOFileHandle sourceHandle, long sourceHandleOffset)
      loadBytes:size:sourceHandle:sourceHandleOffset Encodes a command that loads from a handle and offset into a memory location.
      void loadTextureSliceLevelSizeSourceBytesPerRowSourceBytesPerImageDestinationOriginSourceHandleSourceHandleOffset​(@NotNull MTLTexture texture, long slice, long level, MTLSize size, long sourceBytesPerRow, long sourceBytesPerImage, MTLOrigin destinationOrigin, @NotNull MTLIOFileHandle sourceHandle, long sourceHandleOffset)
      loadTexture:texture:slice:level:size:sourceBytesPerRow:sourceBytesPerImage:destinationOrigin:sourceHandle:sourceHandleOffset: Encodes a command that loads a region from a handle and offset into a texture at a given slice, level and origin.
      void popDebugGroup()
      popDebugGroup Pop the latest named string off of the stack.
      void pushDebugGroup​(@NotNull java.lang.String string)
      pushDebugGroup: Push a new named string onto a stack of string labels.
      void setLabel​(@Nullable java.lang.String value)
      [@property] label An optional label for this handle.
      void signalEventValue​(@NotNull MTLSharedEvent event, long value)
      signalEvent:value: Encodes a command that signals an event with a given value.
      long status()
      [@property] status status reports the completion status of the MTLIOCommandBuffer, pending, cancelled, error or complete.
      void tryCancel()
      tryCancel request a cancellation of an in-flight command buffer.
      void waitForEventValue​(@NotNull MTLSharedEvent event, long value)
      waitForEvent:value: Encodes a command that pauses execution of this command buffer until the specified event reaches a given value.
      void waitUntilCompleted()
      waitUntilCompleted Synchronously wait for this command buffer to complete.

    • Method Detail

      • addBarrier

        void addBarrier()
        addBarrier add a barrier that starts subsequent commands after all the previously encoded commands have completed.

      • addCompletedHandler

        void addCompletedHandler​(@NotNull
                         @NotNull MTLIOCommandBuffer.Block_addCompletedHandler block)
        addCompletedHandler:block: Add a block to be called when this command buffer has completed execution.

      • commit

        void commit()
        commit Commit a command buffer so it can be executed as soon as possible.

      • copyStatusToBufferOffset

        void copyStatusToBufferOffset​(@NotNull
                              @NotNull MTLBuffer buffer,
                              long offset)
        copyStatusToBuffer:buffer:offset Encodes a command that writes the status of this commandBuffer upon completion to a buffer at a given offset

      • enqueue

        void enqueue()
        enqueue Append this command buffer to the end of its MTLCommandQueue.

      • error

        @Nullable
@Nullable NSError error()
        [@property] error If an error occurred during execution, the NSError may contain more details about the problem.

      • label

        @Nullable
@Nullable java.lang.String label()
        [@property] label An optional label for this handle.

      • loadBufferOffsetSizeSourceHandleSourceHandleOffset

        void loadBufferOffsetSizeSourceHandleSourceHandleOffset​(@NotNull
                                                        @NotNull MTLBuffer buffer,
                                                        long offset,
                                                        long size,
                                                        @NotNull
                                                        @NotNull MTLIOFileHandle sourceHandle,
                                                        long sourceHandleOffset)
        loadBuffer:offset:size:sourceHandle:sourceHandleOffset Encodes a command that loads from a handle and offset into a buffer and an offset.

      • loadBytesSizeSourceHandleSourceHandleOffset

        void loadBytesSizeSourceHandleSourceHandleOffset​(@NotNull
                                                 @NotNull org.moe.natj.general.ptr.VoidPtr pointer,
                                                 long size,
                                                 @NotNull
                                                 @NotNull MTLIOFileHandle sourceHandle,
                                                 long sourceHandleOffset)
        loadBytes:size:sourceHandle:sourceHandleOffset Encodes a command that loads from a handle and offset into a memory location.

      • loadTextureSliceLevelSizeSourceBytesPerRowSourceBytesPerImageDestinationOriginSourceHandleSourceHandleOffset

        void loadTextureSliceLevelSizeSourceBytesPerRowSourceBytesPerImageDestinationOriginSourceHandleSourceHandleOffset​(@NotNull
                                                                                                                  @NotNull MTLTexture texture,
                                                                                                                  long slice,
                                                                                                                  long level,
                                                                                                                  MTLSize size,
                                                                                                                  long sourceBytesPerRow,
                                                                                                                  long sourceBytesPerImage,
                                                                                                                  MTLOrigin destinationOrigin,
                                                                                                                  @NotNull
                                                                                                                  @NotNull MTLIOFileHandle sourceHandle,
                                                                                                                  long sourceHandleOffset)
        loadTexture:texture:slice:level:size:sourceBytesPerRow:sourceBytesPerImage:destinationOrigin:sourceHandle:sourceHandleOffset: Encodes a command that loads a region from a handle and offset into a texture at a given slice, level and origin.

      • popDebugGroup

        void popDebugGroup()
        popDebugGroup Pop the latest named string off of the stack.

      • pushDebugGroup

        void pushDebugGroup​(@NotNull
                    @NotNull java.lang.String string)
        pushDebugGroup: Push a new named string onto a stack of string labels.

      • setLabel

        void setLabel​(@Nullable
              @Nullable java.lang.String value)
        [@property] label An optional label for this handle.

      • signalEventValue

        void signalEventValue​(@NotNull
                      @NotNull MTLSharedEvent event,
                      long value)
        signalEvent:value: Encodes a command that signals an event with a given value.

      • status

        long status()
        [@property] status status reports the completion status of the MTLIOCommandBuffer, pending, cancelled, error or complete.

      • tryCancel

        void tryCancel()
        tryCancel request a cancellation of an in-flight command buffer.

      • waitForEventValue

        void waitForEventValue​(@NotNull
                       @NotNull MTLSharedEvent event,
                       long value)
        waitForEvent:value: Encodes a command that pauses execution of this command buffer until the specified event reaches a given value.

      • waitUntilCompleted

        void waitUntilCompleted()
        waitUntilCompleted Synchronously wait for this command buffer to complete.