RAMSES Documentation  27.0.130
Information for RAMSES users and developers
Namespaces | Enumerations | Functions
TextureEnums.h File Reference
#include "ramses-framework-api/RamsesFrameworkTypes.h"
#include "ramses-framework-api/APIExport.h"

Go to the source code of this file.

Namespaces

 ramses
 The RAMSES namespace contains all client side objects and functions used to implement RAMSES applications. RAMSES refers to these applications as clients.
 

Enumerations

enum  ramses::ETextureSamplingMethod {
  ramses::ETextureSamplingMethod_Nearest = 0 , ramses::ETextureSamplingMethod_Linear , ramses::ETextureSamplingMethod_Nearest_MipMapNearest , ramses::ETextureSamplingMethod_Nearest_MipMapLinear ,
  ramses::ETextureSamplingMethod_Linear_MipMapNearest , ramses::ETextureSamplingMethod_Linear_MipMapLinear , ramses::ETextureSamplingMethod_NUMBER_OF_ELEMENTS
}
 Texture sampling method. More...
 
enum  ramses::ETextureAddressMode { ramses::ETextureAddressMode_Clamp = 0 , ramses::ETextureAddressMode_Repeat , ramses::ETextureAddressMode_Mirror , ramses::ETextureAddressMode_NUMBER_OF_ELEMENTS }
 Texture address mode. More...
 
enum class  ramses::ETextureFormat {
  ramses::Invalid = 0 , ramses::R8 , ramses::RG8 , ramses::RGB8 ,
  ramses::RGB565 , ramses::RGBA8 , ramses::RGBA4 , ramses::RGBA5551 ,
  ramses::ETC2RGB , ramses::ETC2RGBA , ramses::R16F , ramses::R32F ,
  ramses::RG16F , ramses::RG32F , ramses::RGB16F , ramses::RGB32F ,
  ramses::RGBA16F , ramses::RGBA32F , ramses::SRGB8 , ramses::SRGB8_ALPHA8 ,
  ramses::ASTC_RGBA_4x4 , ramses::ASTC_RGBA_5x4 , ramses::ASTC_RGBA_5x5 , ramses::ASTC_RGBA_6x5 ,
  ramses::ASTC_RGBA_6x6 , ramses::ASTC_RGBA_8x5 , ramses::ASTC_RGBA_8x6 , ramses::ASTC_RGBA_8x8 ,
  ramses::ASTC_RGBA_10x5 , ramses::ASTC_RGBA_10x6 , ramses::ASTC_RGBA_10x8 , ramses::ASTC_RGBA_10x10 ,
  ramses::ASTC_RGBA_12x10 , ramses::ASTC_RGBA_12x12 , ramses::ASTC_SRGBA_4x4 , ramses::ASTC_SRGBA_5x4 ,
  ramses::ASTC_SRGBA_5x5 , ramses::ASTC_SRGBA_6x5 , ramses::ASTC_SRGBA_6x6 , ramses::ASTC_SRGBA_8x5 ,
  ramses::ASTC_SRGBA_8x6 , ramses::ASTC_SRGBA_8x8 , ramses::ASTC_SRGBA_10x5 , ramses::ASTC_SRGBA_10x6 ,
  ramses::ASTC_SRGBA_10x8 , ramses::ASTC_SRGBA_10x10 , ramses::ASTC_SRGBA_12x10 , ramses::ASTC_SRGBA_12x12 ,
  ramses::NUMBER_OF_ELEMENTS
}
 Texture data format. More...
 
enum  ramses::ETextureCubeFace {
  ramses::ETextureCubeFace_PositiveX = 0 , ramses::ETextureCubeFace_NegativeX , ramses::ETextureCubeFace_PositiveY , ramses::ETextureCubeFace_NegativeY ,
  ramses::ETextureCubeFace_PositiveZ , ramses::ETextureCubeFace_NegativeZ , ramses::ETextureCubeFace_NUMBER_OF_ELEMENTS
}
 Cube texture face identifier. More...
 
enum  ramses::ERenderTargetDepthBufferType { ramses::ERenderTargetDepthBufferType_None = 0 , ramses::ERenderTargetDepthBufferType_Depth , ramses::ERenderTargetDepthBufferType_DepthStencil }
 Enum for type of depth buffer created within a RenderTarget. More...
 
enum  ramses::ERenderBufferType { ramses::ERenderBufferType_Color = 0 , ramses::ERenderBufferType_Depth , ramses::ERenderBufferType_DepthStencil }
 Enum for type of a RenderBuffer. More...
 
enum  ramses::ERenderBufferFormat {
  ramses::ERenderBufferFormat_RGBA4 = 0 , ramses::ERenderBufferFormat_R8 , ramses::ERenderBufferFormat_RG8 , ramses::ERenderBufferFormat_RGB8 ,
  ramses::ERenderBufferFormat_RGBA8 , ramses::ERenderBufferFormat_R16F , ramses::ERenderBufferFormat_R32F , ramses::ERenderBufferFormat_RG16F ,
  ramses::ERenderBufferFormat_RG32F , ramses::ERenderBufferFormat_RGB16F , ramses::ERenderBufferFormat_RGB32F , ramses::ERenderBufferFormat_RGBA16F ,
  ramses::ERenderBufferFormat_RGBA32F , ramses::ERenderBufferFormat_Depth24 , ramses::ERenderBufferFormat_Depth24_Stencil8
}
 Enum for format of a RenderBuffer. More...
 
enum class  ramses::ETextureChannelColor : uint8_t {
  ramses::Red , ramses::Green , ramses::Blue , ramses::Alpha ,
  ramses::One , ramses::Zero
}
 Enum for color of texture channel. More...
 
enum  ramses::ERenderBufferAccessMode { ramses::ERenderBufferAccessMode_WriteOnly = 0 , ramses::ERenderBufferAccessMode_ReadWrite }
 Enum for access mode of a RenderBuffer. More...
 

Functions

RAMSES_API const char * ramses::getTextureSamplingMethodString (ETextureSamplingMethod samplingMethod)
 Returns string representation for sampling method. More...
 
RAMSES_API const char * ramses::getTextureAddressModeString (ETextureAddressMode addressMode)
 Returns string representation for address mode. More...
 
RAMSES_API const char * ramses::getTextureFormatString (ETextureFormat format)
 Returns string representation for texture format. More...
 
RAMSES_API const char * ramses::getTextureCubeFaceString (ETextureCubeFace face)
 Returns string representation for texture's cube face. More...
 
bool ramses::FormatSupportsMipChainGeneration (ETextureFormat format)