GrMtlUniformHandler Class Reference

#include <GrMtlUniformHandler.h>

Inheritance diagram for GrMtlUniformHandler:

Classes
struct	MtlUniformInfo

Public Types
enum	{ kUniformBinding = 0 , kLastUniformBinding = kUniformBinding }
typedef SkTBlockList< MtlUniformInfo >	UniformInfoArray
Public Types inherited from GrGLSLUniformHandler
using	UniformHandle = GrGLSLProgramDataManager::UniformHandle

Public Member Functions
const GrShaderVar &	getUniformVariable (UniformHandle u) const override
const char *	getUniformCStr (UniformHandle u) const override
int	numUniforms () const override
UniformInfo &	uniform (int idx) override
const UniformInfo &	uniform (int idx) const override
Public Member Functions inherited from GrGLSLUniformHandler
virtual	~GrGLSLUniformHandler ()
UniformHandle	addUniform (const GrProcessor *owner, uint32_t visibility, SkSLType type, const char *name, const char **outName=nullptr)
UniformHandle	addUniformArray (const GrProcessor *owner, uint32_t visibility, SkSLType type, const char *name, int arrayCount, const char **outName=nullptr)
GrShaderVar	getUniformMapping (const GrProcessor &owner, SkString rawName) const
GrShaderVar	liftUniformToVertexShader (const GrProcessor &owner, SkString rawName)

Static Public Attributes
static const int	kUniformsPerBlock = 8
static constexpr int	kUniformBindingCount = kLastUniformBinding + 1

Private Member Functions
UniformHandle	internalAddUniformArray (const GrProcessor *owner, uint32_t visibility, SkSLType type, const char *name, bool mangleName, int arrayCount, const char **outName) override
SamplerHandle	addSampler (const GrBackendFormat &, GrSamplerState, const skgpu::Swizzle &, const char *name, const GrShaderCaps *) override
const char *	samplerVariable (SamplerHandle handle) const override
skgpu::Swizzle	samplerSwizzle (SamplerHandle handle) const override
void	appendUniformDecls (GrShaderFlags, SkString *) const override

Friends
class	GrMtlPipelineStateBuilder

Additional Inherited Members
Protected Member Functions inherited from GrGLSLUniformHandler
	GrGLSLUniformHandler (GrGLSLProgramBuilder *program)
Protected Attributes inherited from GrGLSLUniformHandler
GrGLSLProgramBuilder *	fProgramBuilder

Detailed Description

Definition at line 22 of file GrMtlUniformHandler.h.

Member Typedef Documentation

UniformInfoArray

typedef SkTBlockList<MtlUniformInfo> GrMtlUniformHandler::UniformInfoArray

Definition at line 36 of file GrMtlUniformHandler.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kUniformBinding
kLastUniformBinding

Definition at line 26 of file GrMtlUniformHandler.h.

         {
        kUniformBinding = 0,
        kLastUniformBinding = kUniformBinding,
    };

Member Function Documentation

addSampler()

GrGLSLUniformHandler::SamplerHandle GrMtlUniformHandler::addSampler ( const GrBackendFormat &  backendFormat, GrSamplerState  , const skgpu::Swizzle &  swizzle, const char *  name, const GrShaderCaps *  caps  )

overrideprivatevirtual

Implements GrGLSLUniformHandler.

Definition at line 232 of file GrMtlUniformHandler.mm.

                                                    {
    int binding = fSamplers.count();
 
    SkASSERT(name && strlen(name));
 
    constexpr char prefix = 'u';
    SkString mangleName = fProgramBuilder->nameVariable(prefix, name, /*mangle=*/true);
 
    GrTextureType type = backendFormat.textureType();
 
    SkString layoutQualifier;
    layoutQualifier.appendf("metal, binding=%d", binding);
 
    MtlUniformInfo tempInfo;
    tempInfo.fVariable = GrShaderVar{std::move(mangleName),
                                     SkSLCombinedSamplerTypeForTextureType(type),
                                     GrShaderVar::TypeModifier::None,
                                     GrShaderVar::kNonArray,
                                     std::move(layoutQualifier),
                                     SkString()};
 
    tempInfo.fVisibility = kFragment_GrShaderFlag;
    tempInfo.fOwner      = nullptr;
    tempInfo.fRawName    = SkString(name);
    tempInfo.fUBOffset   = 0;
 
    fSamplers.push_back(tempInfo);
 
    fSamplerSwizzles.push_back(swizzle);
    SkASSERT(fSamplerSwizzles.size() == fSamplers.count());
    return GrGLSLUniformHandler::SamplerHandle(fSamplers.count() - 1);
}

appendUniformDecls()

void GrMtlUniformHandler::appendUniformDecls ( GrShaderFlags  visibility, SkString *  out  ) const

overrideprivatevirtual

Implements GrGLSLUniformHandler.

Definition at line 267 of file GrMtlUniformHandler.mm.

                                                                                          {
    for (const UniformInfo& sampler : fSamplers.items()) {
        SkASSERT(sampler.fVariable.getType() == SkSLType::kTexture2DSampler);
        if (visibility == sampler.fVisibility) {
            sampler.fVariable.appendDecl(fProgramBuilder->shaderCaps(), out);
            out->append(";\n");
        }
    }
 
#ifdef SK_DEBUG
    bool firstOffsetCheck = false;
    for (const MtlUniformInfo& localUniform : fUniforms.items()) {
        if (!firstOffsetCheck) {
            // Check to make sure we are starting our offset at 0 so the offset qualifier we
            // set on each variable in the uniform block is valid.
            SkASSERT(0 == localUniform.fUBOffset);
            firstOffsetCheck = true;
        }
    }
#endif
 
    SkString uniformsString;
    for (const UniformInfo& localUniform : fUniforms.items()) {
        if (visibility & localUniform.fVisibility) {
            if (SkSLTypeCanBeUniformValue(localUniform.fVariable.getType())) {
                localUniform.fVariable.appendDecl(fProgramBuilder->shaderCaps(), &uniformsString);
                uniformsString.append(";\n");
            }
        }
    }
 
    if (!uniformsString.isEmpty()) {
        out->appendf("layout (metal, binding=%d) uniform uniformBuffer\n{\n", kUniformBinding);
        out->appendf("%s\n};\n", uniformsString.c_str());
    }
}

getUniformCStr()

const char * GrMtlUniformHandler::getUniformCStr ( UniformHandle  u ) const

inlineoverridevirtual

Shortcut for getUniformVariable(u).c_str()

Implements GrGLSLUniformHandler.

Definition at line 42 of file GrMtlUniformHandler.h.

                                                               {
        return this->getUniformVariable(u).c_str();
    }

getUniformVariable()

const GrShaderVar & GrMtlUniformHandler::getUniformVariable ( UniformHandle  u ) const

inlineoverridevirtual

Implements GrGLSLUniformHandler.

Definition at line 38 of file GrMtlUniformHandler.h.

                                                                          {
        return fUniforms.item(u.toIndex()).fVariable;
    }

internalAddUniformArray()

GrGLSLUniformHandler::UniformHandle GrMtlUniformHandler::internalAddUniformArray ( const GrProcessor *  owner, uint32_t  visibility, SkSLType  type, const char *  name, bool  mangleName, int  arrayCount, const char **  outName  )

overrideprivatevirtual

Implements GrGLSLUniformHandler.

Definition at line 180 of file GrMtlUniformHandler.mm.

                                                                                         {
    SkASSERT(name && strlen(name));
    SkASSERT(SkSLTypeCanBeUniformValue(type));
 
    // TODO this is a bit hacky, lets think of a better way.  Basically we need to be able to use
    // the uniform view matrix name in the GP, and the GP is immutable so it has to tell the PB
    // exactly what name it wants to use for the uniform view matrix.  If we prefix anythings, then
    // the names will mismatch.  I think the correct solution is to have all GPs which need the
    // uniform view matrix, they should upload the view matrix in their setData along with regular
    // uniforms.
    char prefix = 'u';
    if ('u' == name[0] || !strncmp(name, GR_NO_MANGLE_PREFIX, strlen(GR_NO_MANGLE_PREFIX))) {
        prefix = '\0';
    }
    SkString resolvedName = fProgramBuilder->nameVariable(prefix, name, mangleName);
 
    uint32_t offset = get_ubo_aligned_offset(&fCurrentUBOOffset, &fCurrentUBOMaxAlignment,
                                             type, arrayCount);
    SkString layoutQualifier;
    layoutQualifier.appendf("offset=%u", offset);
 
    // When outputing the GLSL, only the outer uniform block will get the Uniform modifier. Thus
    // we set the modifier to none for all uniforms declared inside the block.
    MtlUniformInfo tempInfo;
    tempInfo.fVariable = GrShaderVar{std::move(resolvedName),
                                     type,
                                     GrShaderVar::TypeModifier::None,
                                     arrayCount,
                                     std::move(layoutQualifier),
                                     SkString()};
 
    tempInfo.fVisibility = kFragment_GrShaderFlag | kVertex_GrShaderFlag;
    tempInfo.fOwner      = owner;
    tempInfo.fRawName    = SkString(name);
    tempInfo.fUBOffset   = offset;
 
    fUniforms.push_back(tempInfo);
 
    if (outName) {
        *outName = fUniforms.back().fVariable.c_str();
    }
 
    return GrGLSLUniformHandler::UniformHandle(fUniforms.count() - 1);
}

numUniforms()

int GrMtlUniformHandler::numUniforms ( ) const

inlineoverridevirtual

Implements GrGLSLUniformHandler.

Definition at line 46 of file GrMtlUniformHandler.h.

                                     {
        return fUniforms.count();
    }

samplerSwizzle()

skgpu::Swizzle GrMtlUniformHandler::samplerSwizzle ( SamplerHandle  handle ) const

inlineoverrideprivatevirtual

Implements GrGLSLUniformHandler.

Definition at line 84 of file GrMtlUniformHandler.h.

                                                                     {
        return fSamplerSwizzles[handle.toIndex()];
    }

samplerVariable()

const char * GrMtlUniformHandler::samplerVariable ( SamplerHandle  handle ) const

inlineoverrideprivatevirtual

Implements GrGLSLUniformHandler.

Definition at line 81 of file GrMtlUniformHandler.h.

                                                                     {
        return fSamplers.item(handle.toIndex()).fVariable.c_str();
    }

uniform() [1/2]

const UniformInfo & GrMtlUniformHandler::uniform ( int  idx ) const

inlineoverridevirtual

Implements GrGLSLUniformHandler.

Definition at line 53 of file GrMtlUniformHandler.h.

                                                       {
        return fUniforms.item(idx);
    }

uniform() [2/2]

UniformInfo & GrMtlUniformHandler::uniform ( int  idx )

inlineoverridevirtual

Implements GrGLSLUniformHandler.

Definition at line 50 of file GrMtlUniformHandler.h.

                                           {
        return fUniforms.item(idx);
    }

Friends And Related Symbol Documentation

GrMtlPipelineStateBuilder

friend class GrMtlPipelineStateBuilder

friend

Definition at line 104 of file GrMtlUniformHandler.h.

Member Data Documentation

kUniformBindingCount

constexpr int GrMtlUniformHandler::kUniformBindingCount = kLastUniformBinding + 1

staticconstexpr

Definition at line 30 of file GrMtlUniformHandler.h.

kUniformsPerBlock

const int GrMtlUniformHandler::kUniformsPerBlock = 8

static

Definition at line 24 of file GrMtlUniformHandler.h.

---

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

• third_party/skia/src/gpu/ganesh/mtl/GrMtlUniformHandler.h
• third_party/skia/src/gpu/ganesh/mtl/GrMtlUniformHandler.mm