enums.h

//
// Copyright 2019 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_IMAGING_HGI_ENUMS_H
#define PXR_IMAGING_HGI_ENUMS_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hgi/api.h"
#include <cstdint>
 
PXR_NAMESPACE_OPEN_SCOPE
 
using HgiBits = uint32_t;
 
 
enum HgiDeviceCapabilitiesBits : HgiBits
{
    HgiDeviceCapabilitiesBitsPresentation            = 1 << 0,
    HgiDeviceCapabilitiesBitsBindlessBuffers         = 1 << 1,
    HgiDeviceCapabilitiesBitsConcurrentDispatch      = 1 << 2,
    HgiDeviceCapabilitiesBitsUnifiedMemory           = 1 << 3,
    HgiDeviceCapabilitiesBitsBuiltinBarycentrics     = 1 << 4,
    HgiDeviceCapabilitiesBitsShaderDrawParameters    = 1 << 5,
    HgiDeviceCapabilitiesBitsMultiDrawIndirect       = 1 << 6,
    HgiDeviceCapabilitiesBitsBindlessTextures        = 1 << 7,
    HgiDeviceCapabilitiesBitsShaderDoublePrecision   = 1 << 8,
    HgiDeviceCapabilitiesBitsDepthRangeMinusOnetoOne = 1 << 9,
    HgiDeviceCapabilitiesBitsCppShaderPadding        = 1 << 10,
    HgiDeviceCapabilitiesBitsConservativeRaster      = 1 << 11,
    HgiDeviceCapabilitiesBitsStencilReadback         = 1 << 12,
    HgiDeviceCapabilitiesBitsCustomDepthRange        = 1 << 13,
    HgiDeviceCapabilitiesBitsMetalTessellation       = 1 << 14,
    HgiDeviceCapabilitiesBitsBasePrimitiveOffset     = 1 << 15,
    HgiDeviceCapabilitiesBitsPrimitiveIdEmulation    = 1 << 16,
    HgiDeviceCapabilitiesBitsIndirectCommandBuffers  = 1 << 17,
};
 
using HgiDeviceCapabilities = HgiBits;
 
enum HgiTextureType
{
    HgiTextureType1D = 0,
    HgiTextureType2D,
    HgiTextureType3D,
    HgiTextureType1DArray,
    HgiTextureType2DArray,
 
    HgiTextureTypeCount
};
 
enum HgiTextureUsageBits : HgiBits
{
    HgiTextureUsageBitsColorTarget   = 1 << 0,
    HgiTextureUsageBitsDepthTarget   = 1 << 1,
    HgiTextureUsageBitsStencilTarget = 1 << 2,
    HgiTextureUsageBitsShaderRead    = 1 << 3,
    HgiTextureUsageBitsShaderWrite   = 1 << 4,
 
    HgiTextureUsageCustomBitsBegin = 1 << 5,
};
 
using HgiTextureUsage = HgiBits;
 
enum HgiSamplerAddressMode
{
    HgiSamplerAddressModeClampToEdge = 0,
    HgiSamplerAddressModeMirrorClampToEdge,
    HgiSamplerAddressModeRepeat,
    HgiSamplerAddressModeMirrorRepeat,
    HgiSamplerAddressModeClampToBorderColor,
 
    HgiSamplerAddressModeCount
};
 
enum HgiSamplerFilter
{
    HgiSamplerFilterNearest = 0,
    HgiSamplerFilterLinear  = 1,
 
    HgiSamplerFilterCount
};
 
enum HgiMipFilter
{
    HgiMipFilterNotMipmapped = 0,
    HgiMipFilterNearest      = 1,
    HgiMipFilterLinear       = 2,
 
    HgiMipFilterCount
};
 
enum HgiBorderColor
{
    HgiBorderColorTransparentBlack = 0,
    HgiBorderColorOpaqueBlack      = 1,
    HgiBorderColorOpaqueWhite      = 2,
 
    HgiBorderColorCount
};
 
enum HgiSampleCount
{
    HgiSampleCount1  = 1,
    HgiSampleCount2  = 2,
    HgiSampleCount4  = 4,
    HgiSampleCount8  = 8,
    HgiSampleCount16 = 16,
 
    HgiSampleCountEnd
};
 
enum HgiAttachmentLoadOp
{
    HgiAttachmentLoadOpDontCare = 0,
    HgiAttachmentLoadOpClear,
    HgiAttachmentLoadOpLoad,
    
    HgiAttachmentLoadOpCount
};
 
enum HgiAttachmentStoreOp
{
    HgiAttachmentStoreOpDontCare = 0,
    HgiAttachmentStoreOpStore,
    
    HgiAttachmentStoreOpCount
};
 
enum HgiBufferUsageBits : HgiBits
{
    HgiBufferUsageUniform  = 1 << 0,
    HgiBufferUsageIndex32  = 1 << 1,
    HgiBufferUsageVertex   = 1 << 2,
    HgiBufferUsageStorage  = 1 << 3,
    HgiBufferUsageIndirect = 1 << 4,
 
    HgiBufferUsageCustomBitsBegin = 1 << 5,
};
using HgiBufferUsage = HgiBits;
 
enum HgiShaderStageBits : HgiBits
{
    HgiShaderStageVertex                 = 1 << 0,
    HgiShaderStageFragment               = 1 << 1,
    HgiShaderStageCompute                = 1 << 2,
    HgiShaderStageTessellationControl    = 1 << 3,
    HgiShaderStageTessellationEval       = 1 << 4,
    HgiShaderStageGeometry               = 1 << 5,
    HgiShaderStagePostTessellationControl = 1 << 6,
    HgiShaderStagePostTessellationVertex = 1 << 7,
    HgiShaderStageCustomBitsBegin        = 1 << 8,
};
using HgiShaderStage = HgiBits;
 
enum HgiBindResourceType
{
    HgiBindResourceTypeSampler = 0,
    HgiBindResourceTypeSampledImage,
    HgiBindResourceTypeCombinedSamplerImage,
    HgiBindResourceTypeStorageImage,
    HgiBindResourceTypeUniformBuffer,
    HgiBindResourceTypeStorageBuffer,
    HgiBindResourceTypeTessFactors,
 
    HgiBindResourceTypeCount
};
 
enum HgiPolygonMode
{
    HgiPolygonModeFill = 0,
    HgiPolygonModeLine,
    HgiPolygonModePoint,
 
    HgiPolygonModeCount
};
 
enum HgiCullMode
{
    HgiCullModeNone = 0,
    HgiCullModeFront,
    HgiCullModeBack,
    HgiCullModeFrontAndBack,
 
    HgiCullModeCount
};
 
enum HgiWinding
{
    HgiWindingClockwise = 0,
    HgiWindingCounterClockwise,
 
    HgiWindingCount
};
 
 
enum HgiBlendOp
{
    HgiBlendOpAdd = 0,
    HgiBlendOpSubtract,
    HgiBlendOpReverseSubtract,
    HgiBlendOpMin,
    HgiBlendOpMax,
 
    HgiBlendOpCount
};
 
enum HgiBlendFactor
{
    HgiBlendFactorZero = 0,
    HgiBlendFactorOne,
    HgiBlendFactorSrcColor,
    HgiBlendFactorOneMinusSrcColor,
    HgiBlendFactorDstColor,
    HgiBlendFactorOneMinusDstColor,
    HgiBlendFactorSrcAlpha,
    HgiBlendFactorOneMinusSrcAlpha,
    HgiBlendFactorDstAlpha,
    HgiBlendFactorOneMinusDstAlpha,
    HgiBlendFactorConstantColor,
    HgiBlendFactorOneMinusConstantColor,
    HgiBlendFactorConstantAlpha,
    HgiBlendFactorOneMinusConstantAlpha,
    HgiBlendFactorSrcAlphaSaturate,
    HgiBlendFactorSrc1Color,
    HgiBlendFactorOneMinusSrc1Color,
    HgiBlendFactorSrc1Alpha,
    HgiBlendFactorOneMinusSrc1Alpha,
 
    HgiBlendFactorCount
};
 
enum HgiColorMaskBits : HgiBits
{
    HgiColorMaskRed             = 1 << 0,
    HgiColorMaskGreen           = 1 << 1,
    HgiColorMaskBlue            = 1 << 2,
    HgiColorMaskAlpha           = 1 << 3,
};
using HgiColorMask = HgiBits;
 
enum HgiCompareFunction
{
    HgiCompareFunctionNever = 0,
    HgiCompareFunctionLess,
    HgiCompareFunctionEqual,
    HgiCompareFunctionLEqual,
    HgiCompareFunctionGreater,
    HgiCompareFunctionNotEqual,
    HgiCompareFunctionGEqual,
    HgiCompareFunctionAlways,
 
    HgiCompareFunctionCount
};
 
enum HgiStencilOp
{
    HgiStencilOpKeep = 0,
    HgiStencilOpZero,
    HgiStencilOpReplace,
    HgiStencilOpIncrementClamp,
    HgiStencilOpDecrementClamp,
    HgiStencilOpInvert,
    HgiStencilOpIncrementWrap,
    HgiStencilOpDecrementWrap,
 
    HgiStencilOpCount
};
 
enum HgiComponentSwizzle
{
    HgiComponentSwizzleZero = 0,
    HgiComponentSwizzleOne,
    HgiComponentSwizzleR,
    HgiComponentSwizzleG,
    HgiComponentSwizzleB,
    HgiComponentSwizzleA,
 
    HgiComponentSwizzleCount
};
 
enum HgiPrimitiveType
{
    HgiPrimitiveTypePointList = 0,
    HgiPrimitiveTypeLineList,
    HgiPrimitiveTypeLineStrip,
    HgiPrimitiveTypeTriangleList,
    HgiPrimitiveTypePatchList,
    HgiPrimitiveTypeLineListWithAdjacency,
 
    HgiPrimitiveTypeCount
};
 
enum HgiVertexBufferStepFunction
{
    HgiVertexBufferStepFunctionConstant = 0,
    HgiVertexBufferStepFunctionPerVertex,
    HgiVertexBufferStepFunctionPerInstance,
    HgiVertexBufferStepFunctionPerPatch,
    HgiVertexBufferStepFunctionPerPatchControlPoint,
    HgiVertexBufferStepFunctionPerDrawCommand,
 
    HgiVertexBufferStepFunctionCount
};
 
enum HgiSubmitWaitType
{
    HgiSubmitWaitTypeNoWait = 0,
    HgiSubmitWaitTypeWaitUntilCompleted,
};
 
enum HgiMemoryBarrierBits
{
    HgiMemoryBarrierNone = 0,
    HgiMemoryBarrierAll  = 1 << 0
};
using HgiMemoryBarrier = HgiBits;
 
enum HgiBindingType
{
    HgiBindingTypeValue = 0,
    HgiBindingTypeUniformValue,
    HgiBindingTypeArray,
    HgiBindingTypeUniformArray,
    HgiBindingTypePointer,
};
 
enum HgiInterpolationType
{
    HgiInterpolationDefault = 0,
    HgiInterpolationFlat,
    HgiInterpolationNoPerspective,
};
 
enum HgiSamplingType
{
    HgiSamplingDefault = 0,
    HgiSamplingCentroid,
    HgiSamplingSample,
};
 
enum HgiStorageType
{
    HgiStorageDefault = 0,
    HgiStoragePatch,
};
 
enum HgiShaderTextureType
{
    HgiShaderTextureTypeTexture = 0,
    HgiShaderTextureTypeShadowTexture,
    HgiShaderTextureTypeArrayTexture
};
 
enum HgiComputeDispatch
{
    HgiComputeDispatchSerial = 0,
    HgiComputeDispatchConcurrent
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif