blob: 4ecab9cc01574acf99bd64e9134f7b6e838acd48 [file] [log] [blame]
/*
* Copyright 2013 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef GrTypesPriv_DEFINED
#define GrTypesPriv_DEFINED
#include "GrTypes.h"
#include "SkRefCnt.h"
/**
* Types of shader-language-specific boxed variables we can create. (Currently only GrGLShaderVars,
* but should be applicable to other shader languages.)
*/
enum GrSLType {
kVoid_GrSLType,
kBool_GrSLType,
kInt_GrSLType,
kUint_GrSLType,
kFloat_GrSLType,
kVec2f_GrSLType,
kVec3f_GrSLType,
kVec4f_GrSLType,
kMat22f_GrSLType,
kMat33f_GrSLType,
kMat44f_GrSLType,
kTexture2DSampler_GrSLType,
kITexture2DSampler_GrSLType,
kTextureExternalSampler_GrSLType,
kTexture2DRectSampler_GrSLType,
kBufferSampler_GrSLType,
kTexture2D_GrSLType,
kSampler_GrSLType,
};
enum GrShaderType {
kVertex_GrShaderType,
kGeometry_GrShaderType,
kFragment_GrShaderType,
kLastkFragment_GrShaderType = kFragment_GrShaderType
};
static const int kGrShaderTypeCount = kLastkFragment_GrShaderType + 1;
enum GrShaderFlags {
kNone_GrShaderFlags = 0,
kVertex_GrShaderFlag = 1 << kVertex_GrShaderType,
kGeometry_GrShaderFlag = 1 << kGeometry_GrShaderType,
kFragment_GrShaderFlag = 1 << kFragment_GrShaderType
};
GR_MAKE_BITFIELD_OPS(GrShaderFlags);
enum class GrDrawFace {
kInvalid = -1,
kBoth,
kCCW,
kCW,
};
/**
* Precisions of shader language variables. Not all shading languages support precisions or actually
* vary the internal precision based on the qualifiers. These currently only apply to float types (
* including float vectors and matrices).
*/
enum GrSLPrecision {
kLow_GrSLPrecision,
kMedium_GrSLPrecision,
kHigh_GrSLPrecision,
// Default precision is medium. This is because on OpenGL ES 2 highp support is not
// guaranteed. On (non-ES) OpenGL the specifiers have no effect on precision.
kDefault_GrSLPrecision = kMedium_GrSLPrecision,
kLast_GrSLPrecision = kHigh_GrSLPrecision
};
static const int kGrSLPrecisionCount = kLast_GrSLPrecision + 1;
/** Is the shading language type float (including vectors/matrices)? */
static inline bool GrSLTypeIsFloatType(GrSLType type) {
switch (type) {
case kFloat_GrSLType:
case kVec2f_GrSLType:
case kVec3f_GrSLType:
case kVec4f_GrSLType:
case kMat22f_GrSLType:
case kMat33f_GrSLType:
case kMat44f_GrSLType:
return true;
case kVoid_GrSLType:
case kTexture2DSampler_GrSLType:
case kITexture2DSampler_GrSLType:
case kTextureExternalSampler_GrSLType:
case kTexture2DRectSampler_GrSLType:
case kBufferSampler_GrSLType:
case kBool_GrSLType:
case kInt_GrSLType:
case kUint_GrSLType:
case kTexture2D_GrSLType:
case kSampler_GrSLType:
return false;
}
SkFAIL("Unexpected type");
return false;
}
static inline bool GrSLTypeIs2DCombinedSamplerType(GrSLType type) {
switch (type) {
case kTexture2DSampler_GrSLType:
case kITexture2DSampler_GrSLType:
case kTextureExternalSampler_GrSLType:
case kTexture2DRectSampler_GrSLType:
return true;
case kVoid_GrSLType:
case kFloat_GrSLType:
case kVec2f_GrSLType:
case kVec3f_GrSLType:
case kVec4f_GrSLType:
case kMat22f_GrSLType:
case kMat33f_GrSLType:
case kMat44f_GrSLType:
case kBufferSampler_GrSLType:
case kInt_GrSLType:
case kUint_GrSLType:
case kBool_GrSLType:
case kTexture2D_GrSLType:
case kSampler_GrSLType:
return false;
}
SkFAIL("Unexpected type");
return false;
}
static inline bool GrSLTypeIsCombinedSamplerType(GrSLType type) {
switch (type) {
case kTexture2DSampler_GrSLType:
case kITexture2DSampler_GrSLType:
case kTextureExternalSampler_GrSLType:
case kTexture2DRectSampler_GrSLType:
case kBufferSampler_GrSLType:
return true;
case kVoid_GrSLType:
case kFloat_GrSLType:
case kVec2f_GrSLType:
case kVec3f_GrSLType:
case kVec4f_GrSLType:
case kMat22f_GrSLType:
case kMat33f_GrSLType:
case kMat44f_GrSLType:
case kInt_GrSLType:
case kUint_GrSLType:
case kBool_GrSLType:
case kTexture2D_GrSLType:
case kSampler_GrSLType:
return false;
}
SkFAIL("Unexpected type");
return false;
}
static inline bool GrSLTypeAcceptsPrecision(GrSLType type) {
switch (type) {
case kInt_GrSLType:
case kUint_GrSLType:
case kFloat_GrSLType:
case kVec2f_GrSLType:
case kVec3f_GrSLType:
case kVec4f_GrSLType:
case kMat22f_GrSLType:
case kMat33f_GrSLType:
case kMat44f_GrSLType:
case kTexture2DSampler_GrSLType:
case kITexture2DSampler_GrSLType:
case kTextureExternalSampler_GrSLType:
case kTexture2DRectSampler_GrSLType:
case kBufferSampler_GrSLType:
case kTexture2D_GrSLType:
case kSampler_GrSLType:
return true;
case kVoid_GrSLType:
case kBool_GrSLType:
return false;
}
SkFAIL("Unexpected type");
return false;
}
//////////////////////////////////////////////////////////////////////////////
/**
* Types used to describe format of vertices in arrays.
*/
enum GrVertexAttribType {
kFloat_GrVertexAttribType = 0,
kVec2f_GrVertexAttribType,
kVec3f_GrVertexAttribType,
kVec4f_GrVertexAttribType,
kUByte_GrVertexAttribType, // unsigned byte, e.g. coverage
kVec4ub_GrVertexAttribType, // vector of 4 unsigned bytes, e.g. colors
kVec2us_GrVertexAttribType, // vector of 2 shorts, e.g. texture coordinates
kInt_GrVertexAttribType,
kUint_GrVertexAttribType,
kLast_GrVertexAttribType = kUint_GrVertexAttribType
};
static const int kGrVertexAttribTypeCount = kLast_GrVertexAttribType + 1;
/**
* Returns the size of the attrib type in bytes.
*/
static inline size_t GrVertexAttribTypeSize(GrVertexAttribType type) {
switch (type) {
case kFloat_GrVertexAttribType:
return sizeof(float);
case kVec2f_GrVertexAttribType:
return 2*sizeof(float);
case kVec3f_GrVertexAttribType:
return 3*sizeof(float);
case kVec4f_GrVertexAttribType:
return 4*sizeof(float);
case kUByte_GrVertexAttribType:
return 1*sizeof(char);
case kVec4ub_GrVertexAttribType:
return 4*sizeof(char);
case kVec2us_GrVertexAttribType:
return 2*sizeof(int16_t);
case kInt_GrVertexAttribType:
return sizeof(int32_t);
case kUint_GrVertexAttribType:
return sizeof(uint32_t);
}
SkFAIL("Unexpected attribute type");
return 0;
}
/**
* Is the attrib type integral?
*/
static inline bool GrVertexAttribTypeIsIntType(GrVertexAttribType type) {
switch (type) {
case kFloat_GrVertexAttribType:
return false;
case kVec2f_GrVertexAttribType:
return false;
case kVec3f_GrVertexAttribType:
return false;
case kVec4f_GrVertexAttribType:
return false;
case kUByte_GrVertexAttribType:
return false;
case kVec4ub_GrVertexAttribType:
return false;
case kVec2us_GrVertexAttribType:
return false;
case kInt_GrVertexAttribType:
return true;
case kUint_GrVertexAttribType:
return true;
}
SkFAIL("Unexpected attribute type");
return false;
}
/**
* converts a GrVertexAttribType to a GrSLType
*/
static inline GrSLType GrVertexAttribTypeToSLType(GrVertexAttribType type) {
switch (type) {
case kUByte_GrVertexAttribType:
case kFloat_GrVertexAttribType:
return kFloat_GrSLType;
case kVec2us_GrVertexAttribType:
case kVec2f_GrVertexAttribType:
return kVec2f_GrSLType;
case kVec3f_GrVertexAttribType:
return kVec3f_GrSLType;
case kVec4ub_GrVertexAttribType:
case kVec4f_GrVertexAttribType:
return kVec4f_GrSLType;
case kInt_GrVertexAttribType:
return kInt_GrSLType;
case kUint_GrVertexAttribType:
return kUint_GrSLType;
}
SkFAIL("Unsupported type conversion");
return kVoid_GrSLType;
}
//////////////////////////////////////////////////////////////////////////////
/**
* We have coverage effects that clip rendering to the edge of some geometric primitive.
* This enum specifies how that clipping is performed. Not all factories that take a
* GrProcessorEdgeType will succeed with all values and it is up to the caller to check for
* a NULL return.
*/
enum GrPrimitiveEdgeType {
kFillBW_GrProcessorEdgeType,
kFillAA_GrProcessorEdgeType,
kInverseFillBW_GrProcessorEdgeType,
kInverseFillAA_GrProcessorEdgeType,
kHairlineAA_GrProcessorEdgeType,
kLast_GrProcessorEdgeType = kHairlineAA_GrProcessorEdgeType
};
static const int kGrProcessorEdgeTypeCnt = kLast_GrProcessorEdgeType + 1;
static inline bool GrProcessorEdgeTypeIsFill(const GrPrimitiveEdgeType edgeType) {
return (kFillAA_GrProcessorEdgeType == edgeType || kFillBW_GrProcessorEdgeType == edgeType);
}
static inline bool GrProcessorEdgeTypeIsInverseFill(const GrPrimitiveEdgeType edgeType) {
return (kInverseFillAA_GrProcessorEdgeType == edgeType ||
kInverseFillBW_GrProcessorEdgeType == edgeType);
}
static inline bool GrProcessorEdgeTypeIsAA(const GrPrimitiveEdgeType edgeType) {
return (kFillBW_GrProcessorEdgeType != edgeType && kInverseFillBW_GrProcessorEdgeType != edgeType);
}
static inline GrPrimitiveEdgeType GrInvertProcessorEdgeType(const GrPrimitiveEdgeType edgeType) {
switch (edgeType) {
case kFillBW_GrProcessorEdgeType:
return kInverseFillBW_GrProcessorEdgeType;
case kFillAA_GrProcessorEdgeType:
return kInverseFillAA_GrProcessorEdgeType;
case kInverseFillBW_GrProcessorEdgeType:
return kFillBW_GrProcessorEdgeType;
case kInverseFillAA_GrProcessorEdgeType:
return kFillAA_GrProcessorEdgeType;
case kHairlineAA_GrProcessorEdgeType:
SkFAIL("Hairline fill isn't invertible.");
}
return kFillAA_GrProcessorEdgeType; // suppress warning.
}
/**
* Indicates the type of pending IO operations that can be recorded for gpu resources.
*/
enum GrIOType {
kRead_GrIOType,
kWrite_GrIOType,
kRW_GrIOType
};
/**
* Indicates the type of data that a GPU buffer will be used for.
*/
enum GrBufferType {
kVertex_GrBufferType,
kIndex_GrBufferType,
kTexel_GrBufferType,
kDrawIndirect_GrBufferType,
kXferCpuToGpu_GrBufferType,
kXferGpuToCpu_GrBufferType,
kLast_GrBufferType = kXferGpuToCpu_GrBufferType
};
static const int kGrBufferTypeCount = kLast_GrBufferType + 1;
static inline bool GrBufferTypeIsVertexOrIndex(GrBufferType type) {
SkASSERT(type >= 0 && type < kGrBufferTypeCount);
return type <= kIndex_GrBufferType;
GR_STATIC_ASSERT(0 == kVertex_GrBufferType);
GR_STATIC_ASSERT(1 == kIndex_GrBufferType);
}
/**
* Provides a performance hint regarding the frequency at which a data store will be accessed.
*/
enum GrAccessPattern {
/** Data store will be respecified repeatedly and used many times. */
kDynamic_GrAccessPattern,
/** Data store will be specified once and used many times. (Thus disqualified from caching.) */
kStatic_GrAccessPattern,
/** Data store will be specified once and used at most a few times. (Also can't be cached.) */
kStream_GrAccessPattern,
kLast_GrAccessPattern = kStream_GrAccessPattern
};
#ifdef SK_DEBUG
// Takes a pointer to a GrCaps, and will suppress prints if required
#define GrCapsDebugf(caps, ...) \
if (!caps->suppressPrints()) { \
SkDebugf(__VA_ARGS__); \
}
#else
#define GrCapsDebugf(caps, ...)
#endif
/**
* Specifies if the holder owns the backend, OpenGL or Vulkan, object.
*/
enum class GrBackendObjectOwnership : bool {
/** Holder does not destroy the backend object. */
kBorrowed = false,
/** Holder destroys the backend object. */
kOwned = true
};
template <typename T> T * const * sk_sp_address_as_pointer_address(sk_sp<T> const * sp) {
static_assert(sizeof(T*) == sizeof(sk_sp<T>), "sk_sp not expected size.");
return reinterpret_cast<T * const *>(sp);
}
/*
* Object for CPU-GPU synchronization
*/
typedef intptr_t GrFence;
#endif