TextureEnums.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2014 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_TEXTUREENUMS_H
#define RAMSES_TEXTUREENUMS_H
 
#include "ramses-framework-api/RamsesFrameworkTypes.h"
#include "ramses-framework-api/APIExport.h"
 
namespace ramses
{
    enum ETextureSamplingMethod
    {
        ETextureSamplingMethod_Nearest = 0,
        ETextureSamplingMethod_Linear,
        ETextureSamplingMethod_Nearest_MipMapNearest,
        ETextureSamplingMethod_Nearest_MipMapLinear,
        ETextureSamplingMethod_Linear_MipMapNearest,
        ETextureSamplingMethod_Linear_MipMapLinear,
        ETextureSamplingMethod_NUMBER_OF_ELEMENTS
    };
 
    enum ETextureAddressMode
    {
        ETextureAddressMode_Clamp = 0,
        ETextureAddressMode_Repeat,
        ETextureAddressMode_Mirror,
        ETextureAddressMode_NUMBER_OF_ELEMENTS
    };
 
    enum class ETextureFormat
    {
        Invalid = 0,
 
        R8,
 
        RG8,
 
        RGB8,
        RGB565,
 
        RGBA8,
        RGBA4,
        RGBA5551,
 
        ETC2RGB,
        ETC2RGBA,
 
        R16F,
        R32F,
        RG16F,
        RG32F,
        RGB16F,
        RGB32F,
        RGBA16F,
        RGBA32F,
 
        SRGB8,
        SRGB8_ALPHA8,
 
        // ASTC compressed texture formats - USE WITH CAUTION!
        // ASTC depends on GL ES 3.0 extensions "GL_KHR_texture_compression_astc_hdr" and "GL_KHR_texture_compression_astc_ldr"
        // If the drivers don't support these extensions, expect asserts in the renderer (or black screen in release build)
        // Important note: the "RGBA" in the name only distinguishes between RGBA and sRGBA. The channel count and format are
        // defined internally by the compression algorithm. Refer to the documentation of ASTC extension from above for more details
        ASTC_RGBA_4x4,
        ASTC_RGBA_5x4,
        ASTC_RGBA_5x5,
        ASTC_RGBA_6x5,
        ASTC_RGBA_6x6,
        ASTC_RGBA_8x5,
        ASTC_RGBA_8x6,
        ASTC_RGBA_8x8,
        ASTC_RGBA_10x5,
        ASTC_RGBA_10x6,
        ASTC_RGBA_10x8,
        ASTC_RGBA_10x10,
        ASTC_RGBA_12x10,
        ASTC_RGBA_12x12,
        ASTC_SRGBA_4x4,
        ASTC_SRGBA_5x4,
        ASTC_SRGBA_5x5,
        ASTC_SRGBA_6x5,
        ASTC_SRGBA_6x6,
        ASTC_SRGBA_8x5,
        ASTC_SRGBA_8x6,
        ASTC_SRGBA_8x8,
        ASTC_SRGBA_10x5,
        ASTC_SRGBA_10x6,
        ASTC_SRGBA_10x8,
        ASTC_SRGBA_10x10,
        ASTC_SRGBA_12x10,
        ASTC_SRGBA_12x12,
 
        NUMBER_OF_ELEMENTS
    };
 
    enum ETextureCubeFace
    {
        ETextureCubeFace_PositiveX = 0,
        ETextureCubeFace_NegativeX,
        ETextureCubeFace_PositiveY,
        ETextureCubeFace_NegativeY,
        ETextureCubeFace_PositiveZ,
        ETextureCubeFace_NegativeZ,
        ETextureCubeFace_NUMBER_OF_ELEMENTS
    };
 
    enum ERenderTargetDepthBufferType
    {
        ERenderTargetDepthBufferType_None = 0,
        ERenderTargetDepthBufferType_Depth,
        ERenderTargetDepthBufferType_DepthStencil
    };
 
    enum ERenderBufferType
    {
        ERenderBufferType_Color = 0,
        ERenderBufferType_Depth,
        ERenderBufferType_DepthStencil
    };
 
    enum ERenderBufferFormat
    {
        ERenderBufferFormat_RGBA4 = 0,
        ERenderBufferFormat_R8,
        ERenderBufferFormat_RG8,
        ERenderBufferFormat_RGB8,
        ERenderBufferFormat_RGBA8,
        ERenderBufferFormat_R16F,
        ERenderBufferFormat_R32F,
        ERenderBufferFormat_RG16F,
        ERenderBufferFormat_RG32F,
        ERenderBufferFormat_RGB16F,
        ERenderBufferFormat_RGB32F,
        ERenderBufferFormat_RGBA16F,
        ERenderBufferFormat_RGBA32F,
 
        ERenderBufferFormat_Depth24,
        ERenderBufferFormat_Depth24_Stencil8
    };
 
    enum class ETextureChannelColor : uint8_t
    {
        Red,
        Green,
        Blue,
        Alpha,
        One,
        Zero,
    };
 
 
    enum ERenderBufferAccessMode
    {
        ERenderBufferAccessMode_WriteOnly = 0, 
        ERenderBufferAccessMode_ReadWrite      
    };
 
    RAMSES_API const char* getTextureSamplingMethodString(ETextureSamplingMethod samplingMethod);
 
    RAMSES_API const char* getTextureAddressModeString(ETextureAddressMode addressMode);
 
    RAMSES_API const char* getTextureFormatString(ETextureFormat format);
 
    RAMSES_API const char* getTextureCubeFaceString(ETextureCubeFace face);
 
    inline bool FormatSupportsMipChainGeneration(ETextureFormat format)
    {
        switch (format)
        {
        case ETextureFormat::ETC2RGB:
        case ETextureFormat::ETC2RGBA:
        case ETextureFormat::ASTC_RGBA_4x4:
        case ETextureFormat::ASTC_RGBA_5x4:
        case ETextureFormat::ASTC_RGBA_5x5:
        case ETextureFormat::ASTC_RGBA_6x5:
        case ETextureFormat::ASTC_RGBA_6x6:
        case ETextureFormat::ASTC_RGBA_8x5:
        case ETextureFormat::ASTC_RGBA_8x6:
        case ETextureFormat::ASTC_RGBA_8x8:
        case ETextureFormat::ASTC_RGBA_10x5:
        case ETextureFormat::ASTC_RGBA_10x6:
        case ETextureFormat::ASTC_RGBA_10x8:
        case ETextureFormat::ASTC_RGBA_10x10:
        case ETextureFormat::ASTC_RGBA_12x10:
        case ETextureFormat::ASTC_RGBA_12x12:
        case ETextureFormat::ASTC_SRGBA_4x4:
        case ETextureFormat::ASTC_SRGBA_5x4:
        case ETextureFormat::ASTC_SRGBA_5x5:
        case ETextureFormat::ASTC_SRGBA_6x5:
        case ETextureFormat::ASTC_SRGBA_6x6:
        case ETextureFormat::ASTC_SRGBA_8x5:
        case ETextureFormat::ASTC_SRGBA_8x6:
        case ETextureFormat::ASTC_SRGBA_8x8:
        case ETextureFormat::ASTC_SRGBA_10x5:
        case ETextureFormat::ASTC_SRGBA_10x6:
        case ETextureFormat::ASTC_SRGBA_10x8:
        case ETextureFormat::ASTC_SRGBA_10x10:
        case ETextureFormat::ASTC_SRGBA_12x10:
        case ETextureFormat::ASTC_SRGBA_12x12:
            return false;
        default:
            return true;
        }
    }
}
 
#endif