types.h

//
// Copyright 2020 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HIO_TYPES_H
#define PXR_IMAGING_HIO_TYPES_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hio/api.h"
#include <stdlib.h>
#include <cinttypes>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class GfVec3i;
 
enum HioFormat
{
    HioFormatInvalid=-1,
 
    // UNorm8 - a 1-byte value representing a float between 0 and 1.
    // float value = (unorm / 255.0f);
    HioFormatUNorm8=0,
    HioFormatUNorm8Vec2,
    HioFormatUNorm8Vec3,
    HioFormatUNorm8Vec4,
 
    // SNorm8 - a 1-byte value representing a float between -1 and 1.
    // float value = max(snorm / 127.0f, -1.0f);
    HioFormatSNorm8,
    HioFormatSNorm8Vec2,
    HioFormatSNorm8Vec3,
    HioFormatSNorm8Vec4,
 
    // Float16 - a 2-byte IEEE half-precision float.
    HioFormatFloat16,
    HioFormatFloat16Vec2,
    HioFormatFloat16Vec3,
    HioFormatFloat16Vec4,
 
    // Float32 - a 4-byte IEEE float.
    HioFormatFloat32,
    HioFormatFloat32Vec2,
    HioFormatFloat32Vec3,
    HioFormatFloat32Vec4,
 
    // Double64 - a 8-byte IEEE double.
    HioFormatDouble64,
    HioFormatDouble64Vec2,
    HioFormatDouble64Vec3,
    HioFormatDouble64Vec4,
 
    // UInt16 - a 2-byte unsigned short integer. 
    HioFormatUInt16,
    HioFormatUInt16Vec2,
    HioFormatUInt16Vec3,
    HioFormatUInt16Vec4,
 
    // Int16 - a 2-byte signed short integer. 
    HioFormatInt16,
    HioFormatInt16Vec2,
    HioFormatInt16Vec3,
    HioFormatInt16Vec4,
 
    // UInt32 - a 4-byte unsigned integer. 
    HioFormatUInt32,
    HioFormatUInt32Vec2,
    HioFormatUInt32Vec3,
    HioFormatUInt32Vec4,
 
    // Int32 - a 4-byte signed integer.
    HioFormatInt32,
    HioFormatInt32Vec2,
    HioFormatInt32Vec3,
    HioFormatInt32Vec4,
 
    // UNorm8 SRGB - a 1-byte value representing a float between 0 and 1.
    HioFormatUNorm8srgb,
    HioFormatUNorm8Vec2srgb,
    HioFormatUNorm8Vec3srgb,
    HioFormatUNorm8Vec4srgb,
 
    // BPTC compressed. 3-component, 4x4 blocks, signed floating-point
    HioFormatBC6FloatVec3,
 
    // BPTC compressed. 3-component, 4x4 blocks, unsigned floating-point
    HioFormatBC6UFloatVec3,
 
    // BPTC compressed. 4-component, 4x4 blocks, unsigned byte.
    // Representing a float between 0 and 1.
    HioFormatBC7UNorm8Vec4,
 
    // BPTC compressed. 4-component, 4x4 blocks, unsigned byte, sRGB.
    // Representing a float between 0 and 1.
    HioFormatBC7UNorm8Vec4srgb,
 
    // S3TC/DXT compressed. 4-component, 4x4 blocks, unsigned byte
    // Representing a float between 0 and 1.
    HioFormatBC1UNorm8Vec4,
 
    // S3TC/DXT compressed. 4-component, 4x4 blocks, unsigned byte
    // Representing a float between 0 and 1.
    HioFormatBC3UNorm8Vec4,
 
    HioFormatCount
};
 
enum HioAddressDimension
{
    HioAddressDimensionU,
    HioAddressDimensionV,
    HioAddressDimensionW
};
 
enum HioAddressMode
{
    HioAddressModeClampToEdge = 0,
    HioAddressModeMirrorClampToEdge,
    HioAddressModeRepeat,
    HioAddressModeMirrorRepeat,
    HioAddressModeClampToBorderColor
};
 
enum HioType
{
    HioTypeUnsignedByte,
    HioTypeUnsignedByteSRGB,
    HioTypeSignedByte,
    HioTypeUnsignedShort,
    HioTypeSignedShort,
    HioTypeUnsignedInt,
    HioTypeInt,
    HioTypeHalfFloat,
    HioTypeFloat,
    HioTypeDouble,
    
    HioTypeCount
};
 
HIO_API
HioFormat HioGetFormat(uint32_t nchannels,
                       HioType type,
                       bool isSRGB);
 
HIO_API
HioType HioGetHioType(HioFormat);
 
HIO_API 
int HioGetComponentCount(HioFormat format);
 
HIO_API
size_t HioGetDataSizeOfType(HioFormat hioFormat);
 
HIO_API
size_t HioGetDataSizeOfType(HioType type);
 
HIO_API
size_t HioGetDataSizeOfFormat(HioFormat format,
                             size_t *blockWidth = nullptr,
                             size_t *blockHeight = nullptr);
 
HIO_API
bool HioIsCompressed(HioFormat format);
 
HIO_API
size_t HioGetDataSize(const HioFormat hioFormat, const GfVec3i &dimensions);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif