skgpu::graphite::MtlRenderCommandEncoder Class Reference

#include <MtlRenderCommandEncoder.h>

Inheritance diagram for skgpu::graphite::MtlRenderCommandEncoder:

Public Member Functions
const char *	getResourceType () const override
void	setLabel (NSString *label)
void	pushDebugGroup (NSString *string)
void	popDebugGroup ()
void	insertDebugSignpost (NSString *string)
void	setRenderPipelineState (id< MTLRenderPipelineState > pso)
void	setTriangleFillMode (MTLTriangleFillMode fillMode)
void	setFrontFacingWinding (MTLWinding winding)
void	setViewport (const MTLViewport &viewport)
void	setVertexBuffer (id< MTLBuffer > buffer, NSUInteger offset, NSUInteger index)
void	setVertexBufferOffset (NSUInteger offset, NSUInteger index) SK_API_AVAILABLE(macos(10.11)
void	ios (8.3)
void	tvos (9.0))
void	setFragmentBuffer (id< MTLBuffer > buffer, NSUInteger offset, NSUInteger index)
void	setFragmentBufferOffset (NSUInteger offset, NSUInteger index) SK_API_AVAILABLE(macos(10.11)
void	ios (8.3)
void	tvos (9.0))
void	setVertexBytes (const void *bytes, NSUInteger length, NSUInteger index) SK_API_AVAILABLE(macos(10.11)
void	ios (8.3)
void	tvos (9.0))
void	setFragmentBytes (const void *bytes, NSUInteger length, NSUInteger index) SK_API_AVAILABLE(macos(10.11)
void	ios (8.3)
void	tvos (9.0))
void	setFragmentTexture (id< MTLTexture > texture, NSUInteger index)
void	setFragmentSamplerState (id< MTLSamplerState > sampler, NSUInteger index)
void	setBlendColor (float blendConst[4])
void	setStencilReferenceValue (uint32_t referenceValue)
void	setDepthStencilState (id< MTLDepthStencilState > depthStencilState)
void	setScissorRect (const MTLScissorRect &scissorRect)
void	drawPrimitives (MTLPrimitiveType primitiveType, NSUInteger vertexStart, NSUInteger vertexCount)
void	drawPrimitives (MTLPrimitiveType primitiveType, NSUInteger vertexStart, NSUInteger vertexCount, NSUInteger instanceCount, NSUInteger baseInstance) SK_API_AVAILABLE(macos(10.11)
void	ios (9.0)
void	tvos (9.0))
void	drawPrimitives (MTLPrimitiveType primitiveType, id< MTLBuffer > indirectBuffer, NSUInteger indirectBufferOffset) SK_API_AVAILABLE(macos(10.11)
void	ios (9.0)
void	tvos (9.0))
void	drawIndexedPrimitives (MTLPrimitiveType primitiveType, NSUInteger indexCount, MTLIndexType indexType, id< MTLBuffer > indexBuffer, NSUInteger indexBufferOffset)
void	drawIndexedPrimitives (MTLPrimitiveType primitiveType, NSUInteger indexCount, MTLIndexType indexType, id< MTLBuffer > indexBuffer, NSUInteger indexBufferOffset, NSUInteger instanceCount, NSInteger baseVertex, NSUInteger baseInstance) SK_API_AVAILABLE(macos(10.11)
void	ios (9.0)
void	tvos (9.0))
void	drawIndexedPrimitives (MTLPrimitiveType primitiveType, MTLIndexType indexType, id< MTLBuffer > indexBuffer, NSUInteger indexBufferOffset, id< MTLBuffer > indirectBuffer, NSUInteger indirectBufferOffset) SK_API_AVAILABLE(macos(10.11)
void	ios (9.0)
void	tvos (9.0))
void	endEncoding ()
Public Member Functions inherited from skgpu::graphite::Resource
	Resource (const Resource &)=delete
	Resource (Resource &&)=delete
Resource &	operator= (const Resource &)=delete
Resource &	operator= (Resource &&)=delete
void	ref () const
void	unref () const
void	refCommandBuffer () const
void	unrefCommandBuffer () const
Ownership	ownership () const
skgpu::Budgeted	budgeted () const
size_t	gpuMemorySize () const
UniqueID	uniqueID () const
std::string	getLabel () const
void	setLabel (std::string_view label)
bool	wasDestroyed () const
const GraphiteResourceKey &	key () const
void	setKey (const GraphiteResourceKey &key)
void	dumpMemoryStatistics (SkTraceMemoryDump *traceMemoryDump) const
virtual void	prepareForReturnToCache (const std::function< void()> &takeRef)

Static Public Member Functions
static sk_sp< MtlRenderCommandEncoder >	Make (const SharedContext *sharedContext, id< MTLCommandBuffer > commandBuffer, MTLRenderPassDescriptor *descriptor)

Private Member Functions
void	freeGpuData () override

Additional Inherited Members
Protected Member Functions inherited from skgpu::graphite::Resource
	Resource (const SharedContext *, Ownership, skgpu::Budgeted, size_t gpuMemorySize, std::string_view label, bool commandBufferRefsAsUsageRefs=false)
virtual	~Resource ()
const SharedContext *	sharedContext () const
virtual void	invokeReleaseProc ()
virtual void	onDumpMemoryStatistics (SkTraceMemoryDump *traceMemoryDump, const char *dumpName) const
void	setDeleteASAP ()

Detailed Description

Wraps a MTLRenderCommandEncoder object and associated tracked state

Definition at line 22 of file MtlRenderCommandEncoder.h.

Member Function Documentation

drawIndexedPrimitives() [1/3]

void skgpu::graphite::MtlRenderCommandEncoder::drawIndexedPrimitives	(	MTLPrimitiveType	primitiveType,
		MTLIndexType	indexType,
		id< MTLBuffer >	indexBuffer,
		NSUInteger	indexBufferOffset,
		id< MTLBuffer >	indirectBuffer,
		NSUInteger	indirectBufferOffset
	)

drawIndexedPrimitives() [2/3]

void skgpu::graphite::MtlRenderCommandEncoder::drawIndexedPrimitives ( MTLPrimitiveType  primitiveType, NSUInteger  indexCount, MTLIndexType  indexType, id< MTLBuffer >  indexBuffer, NSUInteger  indexBufferOffset  )

inline

Definition at line 214 of file MtlRenderCommandEncoder.h.

                                                             {
        [(*fCommandEncoder) drawIndexedPrimitives:primitiveType
                                    indexCount:indexCount
                                     indexType:indexType
                                   indexBuffer:indexBuffer
                             indexBufferOffset:indexBufferOffset];
    }

drawIndexedPrimitives() [3/3]

void skgpu::graphite::MtlRenderCommandEncoder::drawIndexedPrimitives	(	MTLPrimitiveType	primitiveType,
		NSUInteger	indexCount,
		MTLIndexType	indexType,
		id< MTLBuffer >	indexBuffer,
		NSUInteger	indexBufferOffset,
		NSUInteger	instanceCount,
		NSInteger	baseVertex,
		NSUInteger	baseInstance
	)

drawPrimitives() [1/3]

void skgpu::graphite::MtlRenderCommandEncoder::drawPrimitives	(	MTLPrimitiveType	primitiveType,
		id< MTLBuffer >	indirectBuffer,
		NSUInteger	indirectBufferOffset
	)

drawPrimitives() [2/3]

void skgpu::graphite::MtlRenderCommandEncoder::drawPrimitives ( MTLPrimitiveType  primitiveType, NSUInteger  vertexStart, NSUInteger  vertexCount  )

inline

Definition at line 190 of file MtlRenderCommandEncoder.h.

                                                {
        [(*fCommandEncoder) drawPrimitives:primitiveType
                               vertexStart:vertexStart
                               vertexCount:vertexCount];
    }

drawPrimitives() [3/3]

void skgpu::graphite::MtlRenderCommandEncoder::drawPrimitives	(	MTLPrimitiveType	primitiveType,
		NSUInteger	vertexStart,
		NSUInteger	vertexCount,
		NSUInteger	instanceCount,
		NSUInteger	baseInstance
	)

endEncoding()

void skgpu::graphite::MtlRenderCommandEncoder::endEncoding ( )

inline

Definition at line 252 of file MtlRenderCommandEncoder.h.

                       {
        [(*fCommandEncoder) endEncoding];
    }

freeGpuData()

void skgpu::graphite::MtlRenderCommandEncoder::freeGpuData ( )

inlineoverrideprivatevirtual

Implements skgpu::graphite::Resource.

Definition at line 283 of file MtlRenderCommandEncoder.h.

                                {
        fCommandEncoder.reset();
    }

getResourceType()

const char * skgpu::graphite::MtlRenderCommandEncoder::getResourceType ( ) const

inlineoverridevirtual

Implements skgpu::graphite::Resource.

Definition at line 38 of file MtlRenderCommandEncoder.h.

{ return "Metal Render Command Encoder"; }

insertDebugSignpost()

void skgpu::graphite::MtlRenderCommandEncoder::insertDebugSignpost ( NSString *  string )

inline

Definition at line 50 of file MtlRenderCommandEncoder.h.

                                               {
        [(*fCommandEncoder) insertDebugSignpost:string];
    }

ios() [1/8]

void skgpu::graphite::MtlRenderCommandEncoder::ios

(

8.

3

)

ios() [2/8]

void skgpu::graphite::MtlRenderCommandEncoder::ios

(

8.

3

)

ios() [3/8]

void skgpu::graphite::MtlRenderCommandEncoder::ios

(

8.

3

)

ios() [4/8]

void skgpu::graphite::MtlRenderCommandEncoder::ios

(

8.

3

)

ios() [5/8]

void skgpu::graphite::MtlRenderCommandEncoder::ios

(

9.

0

)

ios() [6/8]

void skgpu::graphite::MtlRenderCommandEncoder::ios

(

9.

0

)

ios() [7/8]

void skgpu::graphite::MtlRenderCommandEncoder::ios

(

9.

0

)

ios() [8/8]

void skgpu::graphite::MtlRenderCommandEncoder::ios

(

9.

0

)

Make()

static sk_sp< MtlRenderCommandEncoder > skgpu::graphite::MtlRenderCommandEncoder::Make ( const SharedContext *  sharedContext, id< MTLCommandBuffer >  commandBuffer, MTLRenderPassDescriptor *  descriptor  )

inlinestatic

Definition at line 24 of file MtlRenderCommandEncoder.h.

                                                                                    {
        // Inserting a pool here so the autorelease occurs when we return and the
        // only remaining ref is the retain below.
        @autoreleasepool {
            // Adding a retain here to keep our own ref separate from the autorelease pool
            sk_cfp<id<MTLRenderCommandEncoder>> encoder =
                    sk_ret_cfp([commandBuffer renderCommandEncoderWithDescriptor:descriptor]);
            return sk_sp<MtlRenderCommandEncoder>(new MtlRenderCommandEncoder(sharedContext,
                                                                              std::move(encoder)));
        }
    }

popDebugGroup()

void skgpu::graphite::MtlRenderCommandEncoder::popDebugGroup ( )

inline

Definition at line 47 of file MtlRenderCommandEncoder.h.

                         {
        [(*fCommandEncoder) popDebugGroup];
    }

pushDebugGroup()

void skgpu::graphite::MtlRenderCommandEncoder::pushDebugGroup ( NSString *  string )

inline

Definition at line 44 of file MtlRenderCommandEncoder.h.

                                          {
        [(*fCommandEncoder) pushDebugGroup:string];
    }

setBlendColor()

void skgpu::graphite::MtlRenderCommandEncoder::setBlendColor ( float  blendConst[4] )

inline

Definition at line 160 of file MtlRenderCommandEncoder.h.

                                            {
        [(*fCommandEncoder) setBlendColorRed: blendConst[0]
                                       green: blendConst[1]
                                        blue: blendConst[2]
                                       alpha: blendConst[3]];
    }

setDepthStencilState()

void skgpu::graphite::MtlRenderCommandEncoder::setDepthStencilState ( id< MTLDepthStencilState >  depthStencilState )

inline

Definition at line 173 of file MtlRenderCommandEncoder.h.

                                                                          {
        if (depthStencilState != fCurrentDepthStencilState) {
            [(*fCommandEncoder) setDepthStencilState:depthStencilState];
            fCurrentDepthStencilState = depthStencilState;
        }
    }

setFragmentBuffer()

void skgpu::graphite::MtlRenderCommandEncoder::setFragmentBuffer ( id< MTLBuffer >  buffer, NSUInteger  offset, NSUInteger  index  )

inline

Definition at line 103 of file MtlRenderCommandEncoder.h.

                                                                                      {
        SkASSERT(buffer != nil);
        SkASSERT(index < kMaxExpectedBuffers);
        if (@available(macOS 10.11, iOS 8.3, tvOS 9.0, *)) {
            if (fCurrentFragmentBuffer[index] == buffer) {
                this->setFragmentBufferOffset(offset, index);
                return;
            }
        }
        if (fCurrentFragmentBuffer[index] != buffer || fCurrentFragmentOffset[index] != offset) {
            [(*fCommandEncoder) setFragmentBuffer:buffer
                                           offset:offset
                                          atIndex:index];
            fCurrentFragmentBuffer[index] = buffer;
            fCurrentFragmentOffset[index] = offset;
        }
    }

setFragmentBufferOffset()

void skgpu::graphite::MtlRenderCommandEncoder::setFragmentBufferOffset	(	NSUInteger	offset,
		NSUInteger	index
	)

setFragmentBytes()

void skgpu::graphite::MtlRenderCommandEncoder::setFragmentBytes	(	const void *	bytes,
		NSUInteger	length,
		NSUInteger	index
	)

setFragmentSamplerState()

void skgpu::graphite::MtlRenderCommandEncoder::setFragmentSamplerState ( id< MTLSamplerState >  sampler, NSUInteger  index  )

inline

Definition at line 151 of file MtlRenderCommandEncoder.h.

                                                                                {
        SkASSERT(index < kMaxExpectedTextures);
        if (fCurrentSampler[index] != sampler) {
            [(*fCommandEncoder) setFragmentSamplerState: sampler
                                                atIndex: index];
            fCurrentSampler[index] = sampler;
        }
    }

setFragmentTexture()

void skgpu::graphite::MtlRenderCommandEncoder::setFragmentTexture ( id< MTLTexture >  texture, NSUInteger  index  )

inline

Definition at line 143 of file MtlRenderCommandEncoder.h.

                                                                      {
        SkASSERT(index < kMaxExpectedTextures);
        if (fCurrentTexture[index] != texture) {
            [(*fCommandEncoder) setFragmentTexture:texture
                                           atIndex:index];
            fCurrentTexture[index] = texture;
        }
    }

setFrontFacingWinding()

void skgpu::graphite::MtlRenderCommandEncoder::setFrontFacingWinding ( MTLWinding  winding )

inline

Definition at line 68 of file MtlRenderCommandEncoder.h.

                                                   {
        [(*fCommandEncoder) setFrontFacingWinding:winding];
    }

setLabel()

void skgpu::graphite::MtlRenderCommandEncoder::setLabel ( NSString *  label )

inline

Definition at line 40 of file MtlRenderCommandEncoder.h.

                                   {
        [(*fCommandEncoder) setLabel:label];
    }

setRenderPipelineState()

void skgpu::graphite::MtlRenderCommandEncoder::setRenderPipelineState ( id< MTLRenderPipelineState >  pso )

inline

Definition at line 54 of file MtlRenderCommandEncoder.h.

                                                                {
        if (fCurrentRenderPipelineState != pso) {
            [(*fCommandEncoder) setRenderPipelineState:pso];
            fCurrentRenderPipelineState = pso;
        }
    }

setScissorRect()

void skgpu::graphite::MtlRenderCommandEncoder::setScissorRect ( const MTLScissorRect &  scissorRect )

inline

Definition at line 180 of file MtlRenderCommandEncoder.h.

                                                           {
        if (fCurrentScissorRect.x != scissorRect.x ||
            fCurrentScissorRect.y != scissorRect.y ||
            fCurrentScissorRect.width != scissorRect.width ||
            fCurrentScissorRect.height != scissorRect.height) {
            [(*fCommandEncoder) setScissorRect:scissorRect];
            fCurrentScissorRect = scissorRect;
        }
    }

setStencilReferenceValue()

void skgpu::graphite::MtlRenderCommandEncoder::setStencilReferenceValue ( uint32_t  referenceValue )

inline

Definition at line 167 of file MtlRenderCommandEncoder.h.

                                                           {
        if (referenceValue != fCurrentStencilReferenceValue) {
            [(*fCommandEncoder) setStencilReferenceValue:referenceValue];
            fCurrentStencilReferenceValue = referenceValue;
        }
    }

setTriangleFillMode()

void skgpu::graphite::MtlRenderCommandEncoder::setTriangleFillMode ( MTLTriangleFillMode  fillMode )

inline

Definition at line 61 of file MtlRenderCommandEncoder.h.

                                                           {
        if (fCurrentTriangleFillMode != fillMode) {
            [(*fCommandEncoder) setTriangleFillMode:fillMode];
            fCurrentTriangleFillMode = fillMode;
        }
    }

setVertexBuffer()

void skgpu::graphite::MtlRenderCommandEncoder::setVertexBuffer ( id< MTLBuffer >  buffer, NSUInteger  offset, NSUInteger  index  )

inline

Definition at line 76 of file MtlRenderCommandEncoder.h.

                                                                                    {
        SkASSERT(buffer != nil);
        SkASSERT(index < kMaxExpectedBuffers);
        if (@available(macOS 10.11, iOS 8.3, tvOS 9.0, *)) {
            if (fCurrentVertexBuffer[index] == buffer) {
                this->setVertexBufferOffset(offset, index);
                return;
            }
        }
        if (fCurrentVertexBuffer[index] != buffer || fCurrentVertexOffset[index] != offset) {
            [(*fCommandEncoder) setVertexBuffer:buffer
                                         offset:offset
                                        atIndex:index];
            fCurrentVertexBuffer[index] = buffer;
            fCurrentVertexOffset[index] = offset;
        }
    }

setVertexBufferOffset()

void skgpu::graphite::MtlRenderCommandEncoder::setVertexBufferOffset	(	NSUInteger	offset,
		NSUInteger	index
	)

setVertexBytes()

void skgpu::graphite::MtlRenderCommandEncoder::setVertexBytes	(	const void *	bytes,
		NSUInteger	length,
		NSUInteger	index
	)

setViewport()

void skgpu::graphite::MtlRenderCommandEncoder::setViewport ( const MTLViewport &  viewport )

inline

Definition at line 72 of file MtlRenderCommandEncoder.h.

                                                  {
        [(*fCommandEncoder) setViewport:viewport];
    }

tvos() [1/8]

void skgpu::graphite::MtlRenderCommandEncoder::tvos ( 9.  0 )

inline

Definition at line 94 of file MtlRenderCommandEncoder.h.

                                                                {
        SkASSERT(index < kMaxExpectedBuffers);
        if (fCurrentVertexOffset[index] != offset) {
            [(*fCommandEncoder) setVertexBufferOffset:offset
                                              atIndex:index];
            fCurrentVertexOffset[index] = offset;
        }
    }

tvos() [2/8]

void skgpu::graphite::MtlRenderCommandEncoder::tvos ( 9.  0 )

inline

Definition at line 121 of file MtlRenderCommandEncoder.h.

                                                                {
        SkASSERT(index < kMaxExpectedBuffers);
        if (fCurrentFragmentOffset[index] != offset) {
            [(*fCommandEncoder) setFragmentBufferOffset:offset
                                                atIndex:index];
            fCurrentFragmentOffset[index] = offset;
        }
    }

tvos() [3/8]

void skgpu::graphite::MtlRenderCommandEncoder::tvos ( 9.  0 )

inline

Definition at line 131 of file MtlRenderCommandEncoder.h.

                                                                {
        [(*fCommandEncoder) setVertexBytes:bytes
                                    length:length
                                   atIndex:index];
    }

tvos() [4/8]

void skgpu::graphite::MtlRenderCommandEncoder::tvos ( 9.  0 )

inline

Definition at line 137 of file MtlRenderCommandEncoder.h.

                                                                {
        [(*fCommandEncoder) setFragmentBytes:bytes
                                      length:length
                                     atIndex:index];
    }

tvos() [5/8]

void skgpu::graphite::MtlRenderCommandEncoder::tvos ( 9.  0 )

inline

Definition at line 199 of file MtlRenderCommandEncoder.h.

                                                                {
        [(*fCommandEncoder) drawPrimitives:primitiveType
                            vertexStart:vertexStart
                            vertexCount:vertexCount
                          instanceCount:instanceCount
                           baseInstance:baseInstance];
    }

tvos() [6/8]

void skgpu::graphite::MtlRenderCommandEncoder::tvos ( 9.  0 )

inline

Definition at line 208 of file MtlRenderCommandEncoder.h.

                                                                {
        [(*fCommandEncoder) drawPrimitives:primitiveType
                            indirectBuffer:indirectBuffer
                      indirectBufferOffset:indirectBufferOffset];
    }

tvos() [7/8]

void skgpu::graphite::MtlRenderCommandEncoder::tvos ( 9.  0 )

inline

Definition at line 229 of file MtlRenderCommandEncoder.h.

                                                                {
        [(*fCommandEncoder) drawIndexedPrimitives:primitiveType
                                    indexCount:indexCount
                                     indexType:indexType
                                   indexBuffer:indexBuffer
                             indexBufferOffset:indexBufferOffset
                                 instanceCount:instanceCount
                                    baseVertex:baseVertex
                                  baseInstance:baseInstance];
    }

tvos() [8/8]

void skgpu::graphite::MtlRenderCommandEncoder::tvos ( 9.  0 )

inline

Definition at line 243 of file MtlRenderCommandEncoder.h.

                                                                {
        [(*fCommandEncoder) drawIndexedPrimitives:primitiveType
                                        indexType:indexType
                                      indexBuffer:indexBuffer
                                indexBufferOffset:indexBufferOffset
                                   indirectBuffer:indirectBuffer
                             indirectBufferOffset:indirectBufferOffset];
    }

---

The documentation for this class was generated from the following file:

• third_party/skia/src/gpu/graphite/mtl/MtlRenderCommandEncoder.h