apple.metal.protocol

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

Modifier and Type	Method and Description
MTLRenderCommandEncoder	renderCommandEncoder() renderCommandEncoder
void	setColorStoreActionAtIndex(long storeAction, long colorAttachmentIndex) setColorStoreAction:atIndex:
void	setColorStoreActionOptionsAtIndex(long storeActionOptions, long colorAttachmentIndex) setColorStoreActionOptions:atIndex:
void	setDepthStoreAction(long storeAction) setDepthStoreAction:
void	setDepthStoreActionOptions(long storeActionOptions) setDepthStoreActionOptions:
void	setStencilStoreAction(long storeAction) setStencilStoreAction:
void	setStencilStoreActionOptions(long storeActionOptions) setStencilStoreActionOptions:

Methods inherited from interface apple.metal.protocol.MTLCommandEncoder

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

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.