Interface MTLParallelRenderCommandEncoder

  • All Superinterfaces:
    MTLCommandEncoder

    public interface MTLParallelRenderCommandEncoder
    extends MTLCommandEncoder
    [@protocol] MTLParallelRenderCommandEncoder The MTLParallelRenderCommandEncoder protocol is designed to allow a single render to texture operation to be efficiently (and safely) broken up across multiple threads.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      MTLRenderCommandEncoder renderCommandEncoder()
      renderCommandEncoder Return a new autoreleased object that conforms to that may be used to encode on a different thread.
      void setColorStoreActionAtIndex​(long storeAction, long colorAttachmentIndex)
      setColorStoreAction:atIndex: If the the store action for a given color attachment was set to MTLStoreActionUnknown when the render command encoder was created, setColorStoreAction:atIndex: must be used to finalize the store action before endEncoding is called.
      void setColorStoreActionOptionsAtIndex​(long storeActionOptions, long colorAttachmentIndex)
      setColorStoreActionOptions:atIndex: If the the store action for a given color attachment was set to MTLStoreActionUnknown when the render command encoder was created, setColorStoreActionOptions:atIndex: may be used to finalize the store action options before endEncoding is called.
      void setDepthStoreAction​(long storeAction)
      setDepthStoreAction: If the the store action for the depth attachment was set to MTLStoreActionUnknown when the render command encoder was created, setDepthStoreAction: must be used to finalize the store action before endEncoding is called.
      void setDepthStoreActionOptions​(long storeActionOptions)
      setDepthStoreActionOptions: If the the store action for the depth attachment was set to MTLStoreActionUnknown when the render command encoder was created, setDepthStoreActionOptions: may be used to finalize the store action options before endEncoding is called.
      void setStencilStoreAction​(long storeAction)
      setStencilStoreAction: If the the store action for the stencil attachment was set to MTLStoreActionUnknown when the render command encoder was created, setStencilStoreAction: must be used to finalize the store action before endEncoding is called.
      void setStencilStoreActionOptions​(long storeActionOptions)
      setStencilStoreActionOptions: If the the store action for the stencil attachment was set to MTLStoreActionUnknown when the render command encoder was created, setStencilStoreActionOptions: may be used to finalize the store action options before endEncoding is called.
    • Method Detail

      • renderCommandEncoder

        MTLRenderCommandEncoder renderCommandEncoder()
        renderCommandEncoder Return a new autoreleased object that conforms to that may be used to encode on a different thread.
      • setColorStoreActionAtIndex

        void setColorStoreActionAtIndex​(long storeAction,
                                        long colorAttachmentIndex)
        setColorStoreAction:atIndex: If the the store action for a given color attachment was set to MTLStoreActionUnknown when the render command encoder was created, setColorStoreAction:atIndex: must be used to finalize the store action before endEncoding is called.
        Parameters:
        storeAction - The desired store action for the given color attachment. This may be set to any value other than MTLStoreActionUnknown.
        colorAttachmentIndex - The index of the color attachment
      • setDepthStoreAction

        void setDepthStoreAction​(long storeAction)
        setDepthStoreAction: If the the store action for the depth attachment was set to MTLStoreActionUnknown when the render command encoder was created, setDepthStoreAction: must be used to finalize the store action before endEncoding is called.
      • setStencilStoreAction

        void setStencilStoreAction​(long storeAction)
        setStencilStoreAction: If the the store action for the stencil attachment was set to MTLStoreActionUnknown when the render command encoder was created, setStencilStoreAction: must be used to finalize the store action before endEncoding is called.
      • setColorStoreActionOptionsAtIndex

        void setColorStoreActionOptionsAtIndex​(long storeActionOptions,
                                               long colorAttachmentIndex)
        setColorStoreActionOptions:atIndex: If the the store action for a given color attachment was set to MTLStoreActionUnknown when the render command encoder was created, setColorStoreActionOptions:atIndex: may be used to finalize the store action options before endEncoding is called.
        Parameters:
        storeActionOptions - The desired store action options for the given color attachment.
        colorAttachmentIndex - The index of the color attachment
      • setDepthStoreActionOptions

        void setDepthStoreActionOptions​(long storeActionOptions)
        setDepthStoreActionOptions: If the the store action for the depth attachment was set to MTLStoreActionUnknown when the render command encoder was created, setDepthStoreActionOptions: may be used to finalize the store action options before endEncoding is called.
      • setStencilStoreActionOptions

        void setStencilStoreActionOptions​(long storeActionOptions)
        setStencilStoreActionOptions: If the the store action for the stencil attachment was set to MTLStoreActionUnknown when the render command encoder was created, setStencilStoreActionOptions: may be used to finalize the store action options before endEncoding is called.