blob: 381fec3f4dc0d800638022b2883f1d8579916136 [file] [log] [blame]
* Copyright 2014 Google Inc.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
#ifndef GrProgramDesc_DEFINED
#define GrProgramDesc_DEFINED
#include "include/core/SkString.h"
#include "include/private/GrTypesPriv.h"
#include "include/private/SkTArray.h"
#include "include/private/SkTo.h"
#include <limits.h>
class GrCaps;
class GrProgramInfo;
class GrRenderTarget;
/** This class is used to generate a generic program cache key. The Dawn, Metal and Vulkan
* backends derive backend-specific versions which add additional information.
class GrProgramDesc {
GrProgramDesc(const GrProgramDesc& other) = default;
GrProgramDesc& operator=(const GrProgramDesc &other) = default;
bool isValid() const { return !fKey.empty(); }
void reset() { *this = GrProgramDesc{}; }
// Returns this as a uint32_t array to be used as a key in the program cache.
const uint32_t* asKey() const {
// Gets the number of bytes in asKey(). It will be a 4-byte aligned value.
uint32_t keyLength() const {
return fKey.size() * sizeof(uint32_t);
bool operator== (const GrProgramDesc& that) const {
return this->fKey == that.fKey;
bool operator!= (const GrProgramDesc& other) const {
return !(*this == other);
uint32_t initialKeyLength() const { return fInitialKeyLength; }
// TODO(skia:11372): Incorporate this into caps interface (part of makeDesc, or a parallel
// function), so other backends can include their information in the description.
static SkString Describe(const GrProgramInfo&, const GrCaps&);
friend class GrDawnCaps;
friend class GrD3DCaps;
friend class GrGLCaps;
friend class GrMockCaps;
friend class GrMtlCaps;
friend class GrVkCaps;
friend class GrGLGpu; // for ProgramCache to access BuildFromData
friend class GrMtlResourceProvider; // for PipelineStateCache to access BuildFromData
// Creates an uninitialized key that must be populated by Build
GrProgramDesc() {}
* Builds a program descriptor.
* @param desc The built descriptor
* @param programInfo Program information need to build the key
* @param caps the caps
static void Build(GrProgramDesc*, const GrProgramInfo&, const GrCaps&);
// This is strictly an OpenGL call since the other backends have additional data in their keys.
static bool BuildFromData(GrProgramDesc* desc, const void* keyData, size_t keyLength) {
if (!SkTFitsIn<int>(keyLength) || !SkIsAlign4(keyLength)) {
return false;
desc->fKey.reset(keyLength / 4);
memcpy(desc->fKey.begin(), keyData, keyLength);
return true;
enum {
kHeaderSize = 1, // "header" in ::Build
kMaxPreallocProcessors = 8,
kIntsPerProcessor = 4, // This is an overestimate of the average effect key size.
kPreAllocSize = kHeaderSize +
kMaxPreallocProcessors * kIntsPerProcessor,
using KeyType = SkSTArray<kPreAllocSize, uint32_t, true>;
KeyType* key() { return &fKey; }
SkSTArray<kPreAllocSize, uint32_t, true> fKey;
uint32_t fInitialKeyLength = 0;