OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::GLPixelUtil Class Reference

Class to do pixel format mapping between GL and OGRE. More...

#include <OgreGLPixelFormat.h>

Static Public Member Functions

static GLenum getClosestGLInternalFormat (PixelFormat mFormat, bool hwGamma=false)
 Takes the OGRE pixel format and returns the type that must be provided to GL as internal format. More...
 
static PixelFormat getClosestOGREFormat (GLenum fmt)
 Function to get the closest matching OGRE format to an internal GL format. More...
 
static GLenum getGLInternalFormat (PixelFormat mFormat, bool hwGamma=false)
 Takes the OGRE pixel format and returns the type that must be provided to GL as internal format. More...
 
static GLenum getGLOriginDataType (PixelFormat mFormat)
 Takes the OGRE pixel format and returns type that must be provided to GL as data type for reading it into the GPU. More...
 
static GLenum getGLOriginFormat (PixelFormat mFormat)
 Takes the OGRE pixel format and returns the appropriate GL one. More...
 
static size_t getMaxMipmaps (uint32 width, uint32 height, uint32 depth, PixelFormat format)
 Returns the maximum number of Mipmaps that can be generated until we reach the mininum format possible. More...
 
static uint32 optionalPO2 (uint32 value)
 Returns next power-of-two size if required by render system, in case RSC_NON_POWER_OF_2_TEXTURES is supported it returns value as-is. More...
 

Detailed Description

Class to do pixel format mapping between GL and OGRE.

Definition at line 38 of file OgreGLPixelFormat.h.

Member Function Documentation

static GLenum Ogre::GLPixelUtil::getClosestGLInternalFormat ( PixelFormat  mFormat,
bool  hwGamma = false 
)
static

Takes the OGRE pixel format and returns the type that must be provided to GL as internal format.

If no match exists, returns the closest match.

Parameters
mFormatThe pixel format
hwGammaWhether a hardware gamma-corrected version is requested
static PixelFormat Ogre::GLPixelUtil::getClosestOGREFormat ( GLenum  fmt)
static

Function to get the closest matching OGRE format to an internal GL format.

To be precise, the format will be chosen that is most efficient to transfer to the card without losing precision.

Remarks
It is valid for this function to always return PF_A8R8G8B8.
static GLenum Ogre::GLPixelUtil::getGLInternalFormat ( PixelFormat  mFormat,
bool  hwGamma = false 
)
static

Takes the OGRE pixel format and returns the type that must be provided to GL as internal format.

GL_NONE if no match exists.

Parameters
mFormatThe pixel format
hwGammaWhether a hardware gamma-corrected version is requested
static GLenum Ogre::GLPixelUtil::getGLOriginDataType ( PixelFormat  mFormat)
static

Takes the OGRE pixel format and returns type that must be provided to GL as data type for reading it into the GPU.

Returns
a GLenum describing the data type, or 0 if there is no exactly matching one (and conversion is needed)
static GLenum Ogre::GLPixelUtil::getGLOriginFormat ( PixelFormat  mFormat)
static

Takes the OGRE pixel format and returns the appropriate GL one.

Returns
a GLenum describing the format, or 0 if there is no exactly matching one (and conversion is needed)
static size_t Ogre::GLPixelUtil::getMaxMipmaps ( uint32  width,
uint32  height,
uint32  depth,
PixelFormat  format 
)
static

Returns the maximum number of Mipmaps that can be generated until we reach the mininum format possible.

This does not count the base level.

Parameters
widthThe width of the area
heightThe height of the area
depthThe depth of the area
formatThe format of the area
Remarks
In case that the format is non-compressed, this simply returns how many times we can divide this texture in 2 until we reach 1x1. For compressed formats, constraints apply on minimum size and alignment so this might differ.
static uint32 Ogre::GLPixelUtil::optionalPO2 ( uint32  value)
static

Returns next power-of-two size if required by render system, in case RSC_NON_POWER_OF_2_TEXTURES is supported it returns value as-is.


The documentation for this class was generated from the following file: