blob: 11027d8aa90b2445614795386e678e4b05e68820 [file] [log] [blame]
/*
* Copyright 2016 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#include "src/gpu/GrProgramDesc.h"
#include "include/private/SkChecksum.h"
#include "include/private/SkTo.h"
#include "src/gpu/GrPipeline.h"
#include "src/gpu/GrPrimitiveProcessor.h"
#include "src/gpu/GrProcessor.h"
#include "src/gpu/GrProgramInfo.h"
#include "src/gpu/GrRenderTarget.h"
#include "src/gpu/GrShaderCaps.h"
#include "src/gpu/GrTexture.h"
#include "src/gpu/glsl/GrGLSLFragmentProcessor.h"
#include "src/gpu/glsl/GrGLSLFragmentShaderBuilder.h"
enum {
kSamplerOrImageTypeKeyBits = 4
};
static inline uint16_t texture_type_key(GrTextureType type) {
int value = UINT16_MAX;
switch (type) {
case GrTextureType::k2D:
value = 0;
break;
case GrTextureType::kExternal:
value = 1;
break;
case GrTextureType::kRectangle:
value = 2;
break;
default:
SK_ABORT("Unexpected texture type");
value = 3;
break;
}
SkASSERT((value & ((1 << kSamplerOrImageTypeKeyBits) - 1)) == value);
return SkToU16(value);
}
static uint32_t sampler_key(GrTextureType textureType, const GrSwizzle& swizzle,
const GrCaps& caps) {
int samplerTypeKey = texture_type_key(textureType);
static_assert(2 == sizeof(swizzle.asKey()));
uint16_t swizzleKey = swizzle.asKey();
return SkToU32(samplerTypeKey | swizzleKey << kSamplerOrImageTypeKeyBits);
}
static void add_pp_sampler_keys(GrProcessorKeyBuilder* b, const GrPrimitiveProcessor& pp,
const GrCaps& caps) {
int numTextureSamplers = pp.numTextureSamplers();
if (!numTextureSamplers) {
return;
}
for (int i = 0; i < numTextureSamplers; ++i) {
const GrPrimitiveProcessor::TextureSampler& sampler = pp.textureSampler(i);
const GrBackendFormat& backendFormat = sampler.backendFormat();
uint32_t samplerKey = sampler_key(backendFormat.textureType(), sampler.swizzle(), caps);
b->add32(samplerKey);
caps.addExtraSamplerKey(b, sampler.samplerState(), backendFormat);
}
}
/**
* A function which emits a meta key into the key builder. This is required because shader code may
* be dependent on properties of the effect that the effect itself doesn't use
* in its key (e.g. the pixel format of textures used). So we create a meta-key for
* every effect using this function. It is also responsible for inserting the effect's class ID
* which must be different for every GrProcessor subclass. It can fail if an effect uses too many
* transforms, etc, for the space allotted in the meta-key. NOTE, both FPs and GPs share this
* function because it is hairy, though FPs do not have attribs, and GPs do not have transforms
*/
static bool gen_fp_meta_key(const GrFragmentProcessor& fp,
const GrCaps& caps,
uint32_t transformKey,
GrProcessorKeyBuilder* b) {
size_t processorKeySize = b->size();
uint32_t classID = fp.classID();
// Currently we allow 16 bits for the class id and the overall processor key size.
static const uint32_t kMetaKeyInvalidMask = ~((uint32_t)UINT16_MAX);
if ((processorKeySize | classID) & kMetaKeyInvalidMask) {
return false;
}
fp.visitTextureEffects([&](const GrTextureEffect& te) {
const GrBackendFormat& backendFormat = te.view().proxy()->backendFormat();
uint32_t samplerKey = sampler_key(backendFormat.textureType(), te.view().swizzle(), caps);
b->add32(samplerKey);
caps.addExtraSamplerKey(b, te.samplerState(), backendFormat);
});
uint32_t* key = b->add32n(2);
key[0] = (classID << 16) | SkToU32(processorKeySize);
key[1] = transformKey;
return true;
}
static bool gen_pp_meta_key(const GrPrimitiveProcessor& pp,
const GrCaps& caps,
uint32_t transformKey,
GrProcessorKeyBuilder* b) {
size_t processorKeySize = b->size();
uint32_t classID = pp.classID();
// Currently we allow 16 bits for the class id and the overall processor key size.
static const uint32_t kMetaKeyInvalidMask = ~((uint32_t)UINT16_MAX);
if ((processorKeySize | classID) & kMetaKeyInvalidMask) {
return false;
}
add_pp_sampler_keys(b, pp, caps);
uint32_t* key = b->add32n(2);
key[0] = (classID << 16) | SkToU32(processorKeySize);
key[1] = transformKey;
return true;
}
static bool gen_xp_meta_key(const GrXferProcessor& xp, GrProcessorKeyBuilder* b) {
size_t processorKeySize = b->size();
uint32_t classID = xp.classID();
// Currently we allow 16 bits for the class id and the overall processor key size.
static const uint32_t kMetaKeyInvalidMask = ~((uint32_t)UINT16_MAX);
if ((processorKeySize | classID) & kMetaKeyInvalidMask) {
return false;
}
b->add32((classID << 16) | SkToU32(processorKeySize));
return true;
}
static bool gen_frag_proc_and_meta_keys(const GrPrimitiveProcessor& primProc,
const GrFragmentProcessor& fp,
const GrCaps& caps,
GrProcessorKeyBuilder* b) {
for (int i = 0; i < fp.numChildProcessors(); ++i) {
if (auto child = fp.childProcessor(i)) {
if (!gen_frag_proc_and_meta_keys(primProc, *child, caps, b)) {
return false;
}
} else {
// Fold in a sentinel value as the "class ID" for any null children
b->add32(GrProcessor::ClassID::kNull_ClassID);
}
}
fp.getGLSLProcessorKey(*caps.shaderCaps(), b);
return gen_fp_meta_key(fp, caps, primProc.computeCoordTransformsKey(fp), b);
}
bool GrProgramDesc::Build(GrProgramDesc* desc,
GrRenderTarget* renderTarget,
const GrProgramInfo& programInfo,
const GrCaps& caps) {
#ifdef SK_DEBUG
if (renderTarget) {
SkASSERT(programInfo.backendFormat() == renderTarget->backendFormat());
}
#endif
// The descriptor is used as a cache key. Thus when a field of the
// descriptor will not affect program generation (because of the attribute
// bindings in use or other descriptor field settings) it should be set
// to a canonical value to avoid duplicate programs with different keys.
static_assert(0 == kProcessorKeysOffset % sizeof(uint32_t));
// Make room for everything up to the effect keys.
desc->key().reset();
desc->key().push_back_n(kProcessorKeysOffset);
GrProcessorKeyBuilder b(&desc->key());
const GrPrimitiveProcessor& primitiveProcessor = programInfo.primProc();
primitiveProcessor.getGLSLProcessorKey(*caps.shaderCaps(), &b);
primitiveProcessor.getAttributeKey(&b);
if (!gen_pp_meta_key(primitiveProcessor, caps, 0, &b)) {
desc->key().reset();
return false;
}
const GrPipeline& pipeline = programInfo.pipeline();
int numColorFPs = 0, numCoverageFPs = 0;
for (int i = 0; i < pipeline.numFragmentProcessors(); ++i) {
const GrFragmentProcessor& fp = pipeline.getFragmentProcessor(i);
if (!gen_frag_proc_and_meta_keys(primitiveProcessor, fp, caps, &b)) {
desc->key().reset();
return false;
}
if (pipeline.isColorFragmentProcessor(i)) {
++numColorFPs;
} else if (pipeline.isCoverageFragmentProcessor(i)) {
++numCoverageFPs;
}
}
const GrXferProcessor& xp = pipeline.getXferProcessor();
const GrSurfaceOrigin* originIfDstTexture = nullptr;
GrSurfaceOrigin origin;
if (pipeline.dstProxyView().proxy()) {
origin = pipeline.dstProxyView().origin();
originIfDstTexture = &origin;
}
xp.getGLSLProcessorKey(*caps.shaderCaps(), &b, originIfDstTexture);
if (!gen_xp_meta_key(xp, &b)) {
desc->key().reset();
return false;
}
if (programInfo.requestedFeatures() & GrProcessor::CustomFeatures::kSampleLocations) {
SkASSERT(pipeline.isHWAntialiasState());
b.add32(renderTarget->getSamplePatternKey());
}
// --------DO NOT MOVE HEADER ABOVE THIS LINE--------------------------------------------------
// Because header is a pointer into the dynamic array, we can't push any new data into the key
// below here.
KeyHeader* header = desc->atOffset<KeyHeader, kHeaderOffset>();
// make sure any padding in the header is zeroed.
memset(header, 0, kHeaderSize);
header->fWriteSwizzle = pipeline.writeSwizzle().asKey();
header->fColorFragmentProcessorCnt = numColorFPs;
header->fCoverageFragmentProcessorCnt = numCoverageFPs;
SkASSERT(header->fColorFragmentProcessorCnt == numColorFPs);
SkASSERT(header->fCoverageFragmentProcessorCnt == numCoverageFPs);
// If we knew the shader won't depend on origin, we could skip this (and use the same program
// for both origins). Instrumenting all fragment processors would be difficult and error prone.
header->fSurfaceOriginKey =
GrGLSLFragmentShaderBuilder::KeyForSurfaceOrigin(programInfo.origin());
header->fProcessorFeatures = (uint8_t)programInfo.requestedFeatures();
// Ensure enough bits.
SkASSERT(header->fProcessorFeatures == (int) programInfo.requestedFeatures());
header->fSnapVerticesToPixelCenters = pipeline.snapVerticesToPixelCenters();
// The base descriptor only stores whether or not the primitiveType is kPoints. Backend-
// specific versions (e.g., Vulkan) require more detail
header->fHasPointSize = (programInfo.primitiveType() == GrPrimitiveType::kPoints);
header->fInitialKeyLength = desc->keyLength();
// Fail if the initial key length won't fit in 27 bits.
if (header->fInitialKeyLength != desc->keyLength()) {
desc->key().reset();
return false;
}
return true;
}