Package apple.metal.protocol

Interface MTLFunction

  • public interface MTLFunction
    [@protocol] MTLFunction A handle to intermediate code used as inputs for either a MTLComputePipelineState or a MTLRenderPipelineState. MTLFunction is a single vertex shader, fragment shader, or compute function. A Function can only be used with the device that it was created against. API-Since: 8.0

    • Method Detail

      • device

        @NotNull
@NotNull MTLDevice device()
        [@property] device The device this resource was created against. This resource can only be used with this device.

      • functionConstantsDictionary

        @NotNull
@NotNull NSDictionary<java.lang.String,​? extends MTLFunctionConstant> functionConstantsDictionary()
        [@property] functionConstantsDictionary A dictionary containing information about all function contents, keyed by the constant names. API-Since: 10.0

      • functionType

        long functionType()
        [@property] functionType The overall kind of entry point: compute, vertex, or fragment.

      • label

        @Nullable
@Nullable java.lang.String label()
        [@property] label A string to help identify this object. API-Since: 10.0

      • name

        @NotNull
@NotNull java.lang.String name()
        [@property] name The name of the function in the shading language.

      • patchControlPointCount

        long patchControlPointCount()
        [@property] patchControlPointCount Returns the number of patch control points if it was specified in the shader. Returns -1 if it was not specified. API-Since: 10.0

      • patchType

        long patchType()
        [@property] patchType Returns the patch type. MTLPatchTypeNone if it is not a post tessellation vertex shader. API-Since: 10.0

      • setLabel

        void setLabel​(@Nullable
              @Nullable java.lang.String value)
        [@property] label A string to help identify this object. API-Since: 10.0

      • stageInputAttributes

        @Nullable
@Nullable NSArray<? extends MTLAttribute> stageInputAttributes()
        [@property] stageInputAttributes Returns an array describing the attributes API-Since: 10.0

      • newArgumentEncoderWithBufferIndex

        @NotNull
@NotNull MTLArgumentEncoder newArgumentEncoderWithBufferIndex​(long bufferIndex)
        newArgumentEncoderWithBufferIndex: Creates an argument encoder which will encode arguments matching the layout of the argument buffer at the given bind point index. API-Since: 11.0

      • newArgumentEncoderWithBufferIndexReflection

        @Deprecated
@NotNull
@NotNull MTLArgumentEncoder newArgumentEncoderWithBufferIndexReflection​(long bufferIndex,
                                                                        @Nullable
                                                                        @Nullable org.moe.natj.general.ptr.Ptr<MTLArgument> reflection)
        Deprecated.
        newArgumentEncoderWithBufferIndex: Creates an argument encoder which will encode arguments matching the layout of the argument buffer at the given bind point index. API-Since: 11.0 Deprecated-Since: 16.0 Deprecated-Message: Use MTLDevice's newArgumentEncoderWithBufferBinding: instead

      • options

        long options()
        [@property] options The options this function was created with. API-Since: 14.0