OGRE  13.6
Object-Oriented Graphics Rendering Engine
Ogre::Image Class Reference

Class representing an image file. More...

#include <OgreImage.h>

+ Inheritance diagram for Ogre::Image:

Public Types

enum  Filter { FILTER_NEAREST , FILTER_LINEAR , FILTER_BILINEAR = FILTER_LINEAR }
 

Public Member Functions

 Image (const Image &img)
 Copy-constructor - copies all the data from the target image. More...
 
 Image (PixelFormat format=PF_UNKNOWN, uint32 width=0, uint32 height=0, uint32 depth=1, uchar *buffer=NULL, bool autoDelete=true)
 Standard constructor. More...
 
 ~Image ()
 Standard destructor. More...
 
ImagecombineTwoImagesAsRGBA (const Image &rgb, const Image &alpha, PixelFormat format=PF_BYTE_RGBA)
 Utility method to combine 2 separate images into this one, with the first image source supplying the RGB channels, and the second image supplying the alpha channel (as luminance or separate alpha). More...
 
void create (PixelFormat format, uint32 width, uint32 height, uint32 depth=1, uint32 numFaces=1, uint32 numMipMaps=0)
 allocates a buffer of given size if needed More...
 
DataStreamPtr encode (const String &formatextension)
 Encode the image and return a stream to the data. More...
 
ImageflipAroundX ()
 Flips (mirrors) the image around the X-axis. More...
 
ImageflipAroundY ()
 Flips (mirrors) the image around the Y-axis. More...
 
void freeMemory ()
 Delete all the memory held by this image, if owned by this image (not dynamic) More...
 
uchar getBPP () const
 Returns the number of bits per pixel. More...
 
ColourValue getColourAt (uint32 x, uint32 y, uint32 z) const
 Get colour value from a certain location in the image. More...
 
uchargetData (uint32 x=0, uint32 y=0, uint32 z=0)
 Returns a pointer to the internal image buffer at the specified pixel location. More...
 
template<typename T >
T * getData (uint32 x=0, uint32 y=0, uint32 z=0)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
const uchargetData (uint32 x=0, uint32 y=0, uint32 z=0) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
template<typename T >
const T * getData (uint32 x=0, uint32 y=0, uint32 z=0) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
uint32 getDepth (void) const
 Gets the depth of the image. More...
 
PixelFormat getFormat () const
 Returns the image format. More...
 
bool getHasAlpha () const
 Returns true if the image has an alpha component. More...
 
uint32 getHeight (void) const
 Gets the height of the image in pixels. More...
 
uint32 getNumFaces (void) const
 Get the number of faces of the image. More...
 
uint32 getNumMipmaps () const
 Returns the number of mipmaps contained in the image. More...
 
PixelBox getPixelBox (uint32 face=0, uint32 mipmap=0) const
 Get a PixelBox encapsulating the image data of a mipmap. More...
 
size_t getRowSpan (void) const
 Gets the physical width in bytes of each row of pixels. More...
 
size_t getSize () const
 Returns the size of the data buffer in bytes. More...
 
uint32 getWidth (void) const
 Gets the width of the image in pixels. More...
 
bool hasFlag (const ImageFlags imgFlag) const
 Returns true if the image has the appropriate flag set. More...
 
Imageload (const DataStreamPtr &stream, const String &type=BLANKSTRING)
 Loads an image file from a stream. More...
 
Imageload (const String &filename, const String &groupName)
 Loads an image file. More...
 
ImageloadDynamicImage (uchar *data, uint32 width, uint32 height, PixelFormat format)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
ImageloadDynamicImage (uchar *data, uint32 width, uint32 height, uint32 depth, PixelFormat format, bool autoDelete=false, uint32 numFaces=1, uint32 numMipMaps=0)
 Stores a pointer to raw data in memory. More...
 
ImageloadRawData (const DataStreamPtr &stream, uint32 width, uint32 height, PixelFormat format)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
ImageloadRawData (const DataStreamPtr &stream, uint32 width, uint32 height, uint32 depth, PixelFormat format, uint32 numFaces=1, uint32 numMipMaps=0)
 Loads raw data from a stream. More...
 
ImageloadTwoImagesAsRGBA (const DataStreamPtr &rgbStream, const DataStreamPtr &alphaStream, PixelFormat format=PF_BYTE_RGBA, const String &rgbType=BLANKSTRING, const String &alphaType=BLANKSTRING)
 Utility method to combine 2 separate images into this one, with the first image source supplying the RGB channels, and the second image supplying the alpha channel (as luminance or separate alpha). More...
 
ImageloadTwoImagesAsRGBA (const String &rgbFilename, const String &alphaFilename, const String &groupName, PixelFormat format=PF_BYTE_RGBA)
 Utility method to combine 2 separate images into this one, with the first image source supplying the RGB channels, and the second image supplying the alpha channel (as luminance or separate alpha). More...
 
Imageoperator= (const Image &img)
 Assignment operator - copies all the data from the target image. More...
 
void resize (ushort width, ushort height, Filter filter=FILTER_BILINEAR)
 Resize a 2D image, applying the appropriate filter. More...
 
void save (const String &filename)
 Save the image as a file. More...
 
void setColourAt (ColourValue const &cv, uint32 x, uint32 y, uint32 z)
 Set colour value at a certain location in the image. More...
 
void setTo (const ColourValue &col)
 sets all pixels to the specified colour More...
 

Static Public Member Functions

static void applyGamma (uchar *buffer, Real gamma, size_t size, uchar bpp)
 Does gamma adjustment. More...
 
static size_t calculateSize (uint32 mipmaps, uint32 faces, uint32 width, uint32 height, uint32 depth, PixelFormat format)
 Static function to calculate size in bytes from the number of mipmaps, faces and the dimensions. More...
 
static String getFileExtFromMagic (DataStreamPtr stream)
 Static function to get an image type string from a stream via magic numbers. More...
 
static void scale (const PixelBox &src, const PixelBox &dst, Filter filter=FILTER_BILINEAR)
 Scale a 1D, 2D or 3D image volume. More...
 

Detailed Description

Class representing an image file.

The Image class usually holds uncompressed image data and is the
only object that can be loaded in a texture. Image  objects handle 
image data decoding themselves by the means of locating the correct 
Codec object for each data type.
Typically, you would want to use an Image object to load a texture when extra processing needs to be done on an image before it is loaded or when you want to blit to an existing texture.

Member Enumeration Documentation

◆ Filter

Enumerator
FILTER_NEAREST 
FILTER_LINEAR 
FILTER_BILINEAR 

Constructor & Destructor Documentation

◆ Image() [1/2]

Ogre::Image::Image ( PixelFormat  format = PF_UNKNOWN,
uint32  width = 0,
uint32  height = 0,
uint32  depth = 1,
uchar buffer = NULL,
bool  autoDelete = true 
)

Standard constructor.

allocates a buffer of given size if buffer pointer is NULL.

◆ Image() [2/2]

Ogre::Image::Image ( const Image img)

Copy-constructor - copies all the data from the target image.

◆ ~Image()

Ogre::Image::~Image ( )

Standard destructor.

Member Function Documentation

◆ create()

void Ogre::Image::create ( PixelFormat  format,
uint32  width,
uint32  height,
uint32  depth = 1,
uint32  numFaces = 1,
uint32  numMipMaps = 0 
)

allocates a buffer of given size if needed

  • If the current allocation is equal to the requested size, this does nothing
  • Otherwise any current allocation is freed, and memory of specified size is allocated
See also
loadDynamicImage

Referenced by Ogre::TinyDepthBuffer::TinyDepthBuffer().

◆ operator=()

Image& Ogre::Image::operator= ( const Image img)

Assignment operator - copies all the data from the target image.

◆ setTo()

void Ogre::Image::setTo ( const ColourValue col)

sets all pixels to the specified colour

format conversion is performed as needed

◆ flipAroundY()

Image& Ogre::Image::flipAroundY ( )

Flips (mirrors) the image around the Y-axis.

An example of an original and flipped image:
<pre>                
originalimg
00000000000
00000000000
00000000000
00000000000
00000000000
------------> flip axis
00000000000
00000000000
00000000000
00000000000
00000000000
originalimg
</pre>

◆ flipAroundX()

Image& Ogre::Image::flipAroundX ( )

Flips (mirrors) the image around the X-axis.

An example of an original and flipped image:
<pre>
        flip axis
            |
originalimg|gmilanigiro
00000000000|00000000000
00000000000|00000000000
00000000000|00000000000
00000000000|00000000000
00000000000|00000000000
</pre>

◆ loadDynamicImage() [1/2]

Image& Ogre::Image::loadDynamicImage ( uchar data,
uint32  width,
uint32  height,
uint32  depth,
PixelFormat  format,
bool  autoDelete = false,
uint32  numFaces = 1,
uint32  numMipMaps = 0 
)

Stores a pointer to raw data in memory.

The pixel format has to be specified.

This method loads an image into memory held in the object. The 
pixel format will be either greyscale or RGB with an optional
Alpha component.
The type can be determined by calling getFormat().             
Note
Whilst typically your image is likely to be a simple 2D image, you can define complex images including cube maps, volume maps, and images including custom mip levels. The layout of the internal memory should be:
  • face 0, mip 0 (top), width x height (x depth)
  • face 0, mip 1, width/2 x height/2 (x depth/2)
  • face 0, mip 2, width/4 x height/4 (x depth/4)
  • .. remaining mips for face 0 ..
  • face 1, mip 0 (top), width x height (x depth)</li
  • .. and so on.
Of course, you will never have multiple faces (cube map) and depth too.
Parameters
dataThe data pointer
widthWidth of image
heightHeight of image
depthImage Depth (in 3d images, numbers of layers, otherwise 1)
formatPixel Format
autoDeleteIf memory associated with this buffer is to be destroyed with the Image object. Note: it's important that if you set this option to true, that you allocated the memory using OGRE_ALLOC_T with a category of MEMCATEGORY_GENERAL to ensure the freeing of memory matches up.
numFacesThe number of faces the image data has inside (6 for cubemaps, 1 otherwise)
numMipMapsThe number of mipmaps the image data has inside
Note
The memory associated with this buffer is NOT destroyed with the Image object, unless autoDelete is set to true.

The size of the buffer must be numFaces * PixelUtil::getMemorySize(width, height, depth, format)

◆ loadDynamicImage() [2/2]

Image& Ogre::Image::loadDynamicImage ( uchar data,
uint32  width,
uint32  height,
PixelFormat  format 
)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ loadRawData() [1/2]

Image& Ogre::Image::loadRawData ( const DataStreamPtr stream,
uint32  width,
uint32  height,
uint32  depth,
PixelFormat  format,
uint32  numFaces = 1,
uint32  numMipMaps = 0 
)

Loads raw data from a stream.

See the function loadDynamicImage for a description of the parameters.

The size of the buffer must be numFaces * PixelUtil::getMemorySize(width, height, depth, format)
Note
Whilst typically your image is likely to be a simple 2D image, you can define complex images including cube maps and images including custom mip levels. The layout of the internal memory should be:
  • face 0, mip 0 (top), width x height (x depth)
  • face 0, mip 1, width/2 x height/2 (x depth/2)
  • face 0, mip 2, width/4 x height/4 (x depth/4)
  • .. remaining mips for face 0 ..
  • face 1, mip 0 (top), width x height (x depth)</li
  • .. and so on.
Of course, you will never have multiple faces (cube map) and depth too.

◆ loadRawData() [2/2]

Image& Ogre::Image::loadRawData ( const DataStreamPtr stream,
uint32  width,
uint32  height,
PixelFormat  format 
)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ load() [1/2]

Image& Ogre::Image::load ( const String filename,
const String groupName 
)

Loads an image file.

This method loads an image into memory. Any format for which 
an associated ImageCodec is registered can be loaded. 
This can include complex formats like DDS with embedded custom 
mipmaps, cube faces and volume textures.
The type can be determined by calling getFormat().             
Parameters
filenameName of an image file to load.
groupNameName of the resource group to search for the image
Note
The memory associated with this buffer is destroyed with the Image object.

◆ load() [2/2]

Image& Ogre::Image::load ( const DataStreamPtr stream,
const String type = BLANKSTRING 
)

Loads an image file from a stream.

This method works in the same way as the filename-based load 
method except it loads the image from a DataStream object. 
This DataStream is expected to contain the 
encoded data as it would be held in a file. 
Any format for which an associated ImageCodec is registered 
can be loaded. 
This can include complex formats like DDS with embedded custom 
mipmaps, cube faces and volume textures.
The type can be determined by calling getFormat().             
Parameters
streamThe source data.
typeThe type of the image. Used to decide what decompression codec to use. Can be left blank if the stream data includes a header to identify the data.
See also
Image::load( const String& filename )

◆ loadTwoImagesAsRGBA() [1/2]

Image& Ogre::Image::loadTwoImagesAsRGBA ( const String rgbFilename,
const String alphaFilename,
const String groupName,
PixelFormat  format = PF_BYTE_RGBA 
)

Utility method to combine 2 separate images into this one, with the first image source supplying the RGB channels, and the second image supplying the alpha channel (as luminance or separate alpha).

Parameters
rgbFilenameFilename of image supplying the RGB channels (any alpha is ignored)
alphaFilenameFilename of image supplying the alpha channel. If a luminance image the single channel is used directly, if an RGB image then the values are converted to greyscale.
groupNameThe resource group from which to load the images
formatThe destination format

◆ loadTwoImagesAsRGBA() [2/2]

Image& Ogre::Image::loadTwoImagesAsRGBA ( const DataStreamPtr rgbStream,
const DataStreamPtr alphaStream,
PixelFormat  format = PF_BYTE_RGBA,
const String rgbType = BLANKSTRING,
const String alphaType = BLANKSTRING 
)

Utility method to combine 2 separate images into this one, with the first image source supplying the RGB channels, and the second image supplying the alpha channel (as luminance or separate alpha).

Parameters
rgbStreamStream of image supplying the RGB channels (any alpha is ignored)
alphaStreamStream of image supplying the alpha channel. If a luminance image the single channel is used directly, if an RGB image then the values are converted to greyscale.
formatThe destination format
rgbTypeThe type of the RGB image. Used to decide what decompression codec to use. Can be left blank if the stream data includes a header to identify the data.
alphaTypeThe type of the alpha image. Used to decide what decompression codec to use. Can be left blank if the stream data includes a header to identify the data.

◆ combineTwoImagesAsRGBA()

Image& Ogre::Image::combineTwoImagesAsRGBA ( const Image rgb,
const Image alpha,
PixelFormat  format = PF_BYTE_RGBA 
)

Utility method to combine 2 separate images into this one, with the first image source supplying the RGB channels, and the second image supplying the alpha channel (as luminance or separate alpha).

Parameters
rgbImage supplying the RGB channels (any alpha is ignored)
alphaImage supplying the alpha channel. If a luminance image the single channel is used directly, if an RGB image then the values are converted to greyscale.
formatThe destination format

◆ save()

void Ogre::Image::save ( const String filename)

Save the image as a file.

Saving and loading are implemented by back end (sometimes third party) codecs. Implemented saving functionality is more limited than loading in some cases. Particularly DDS file format support is currently limited to true colour or single channel float32, square, power of two textures with no mipmaps. Volumetric support is currently limited to DDS files.

◆ encode()

DataStreamPtr Ogre::Image::encode ( const String formatextension)

Encode the image and return a stream to the data.

Parameters
formatextensionAn extension to identify the image format to encode into, e.g. "jpg" or "png"

◆ getData() [1/4]

uchar* Ogre::Image::getData ( uint32  x = 0,
uint32  y = 0,
uint32  z = 0 
)
inline

Returns a pointer to the internal image buffer at the specified pixel location.

Be careful with this method. You will almost certainly prefer to use getPixelBox, especially with complex images which include many faces or custom mipmaps.

Referenced by Ogre::IShader::sample2D().

◆ getData() [2/4]

const uchar* Ogre::Image::getData ( uint32  x = 0,
uint32  y = 0,
uint32  z = 0 
) const
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getData() [3/4]

template<typename T >
T* Ogre::Image::getData ( uint32  x = 0,
uint32  y = 0,
uint32  z = 0 
)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getData() [4/4]

template<typename T >
const T* Ogre::Image::getData ( uint32  x = 0,
uint32  y = 0,
uint32  z = 0 
) const
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getSize()

size_t Ogre::Image::getSize ( ) const
inline

Returns the size of the data buffer in bytes.

◆ getNumMipmaps()

uint32 Ogre::Image::getNumMipmaps ( ) const
inline

Returns the number of mipmaps contained in the image.

◆ hasFlag()

bool Ogre::Image::hasFlag ( const ImageFlags  imgFlag) const
inline

Returns true if the image has the appropriate flag set.

◆ getWidth()

uint32 Ogre::Image::getWidth ( void  ) const
inline

Gets the width of the image in pixels.

Referenced by Ogre::IShader::sample2D().

◆ getHeight()

uint32 Ogre::Image::getHeight ( void  ) const
inline

Gets the height of the image in pixels.

Referenced by Ogre::IShader::sample2D().

◆ getDepth()

uint32 Ogre::Image::getDepth ( void  ) const
inline

Gets the depth of the image.

◆ getNumFaces()

uint32 Ogre::Image::getNumFaces ( void  ) const
inline

Get the number of faces of the image.

This is usually 6 for a cubemap, and 1 for a normal image.

References Ogre::IF_CUBEMAP.

◆ getRowSpan()

size_t Ogre::Image::getRowSpan ( void  ) const
inline

Gets the physical width in bytes of each row of pixels.

◆ getFormat()

PixelFormat Ogre::Image::getFormat ( ) const
inline

Returns the image format.

◆ getBPP()

uchar Ogre::Image::getBPP ( ) const
inline

Returns the number of bits per pixel.

◆ getHasAlpha()

bool Ogre::Image::getHasAlpha ( ) const

Returns true if the image has an alpha component.

◆ applyGamma()

static void Ogre::Image::applyGamma ( uchar buffer,
Real  gamma,
size_t  size,
uchar  bpp 
)
static

Does gamma adjustment.

Note
Basic algo taken from Titan Engine, copyright (c) 2000 Ignacio Castano Iguado

◆ getColourAt()

ColourValue Ogre::Image::getColourAt ( uint32  x,
uint32  y,
uint32  z 
) const

Get colour value from a certain location in the image.

The z coordinate is only valid for cubemaps and volume textures. This uses the first (largest) mipmap.

◆ setColourAt()

void Ogre::Image::setColourAt ( ColourValue const &  cv,
uint32  x,
uint32  y,
uint32  z 
)

Set colour value at a certain location in the image.

The z coordinate is only valid for cubemaps and volume textures. This uses the first (largest) mipmap.

◆ getPixelBox()

PixelBox Ogre::Image::getPixelBox ( uint32  face = 0,
uint32  mipmap = 0 
) const

Get a PixelBox encapsulating the image data of a mipmap.

◆ freeMemory()

void Ogre::Image::freeMemory ( )

Delete all the memory held by this image, if owned by this image (not dynamic)

◆ scale()

static void Ogre::Image::scale ( const PixelBox src,
const PixelBox dst,
Filter  filter = FILTER_BILINEAR 
)
static

Scale a 1D, 2D or 3D image volume.

Parameters
srcPixelBox containing the source pointer, dimensions and format
dstPixelBox containing the destination pointer, dimensions and format
filterWhich filter to use
Remarks
This function can do pixel format conversion in the process.
Note
dst and src can point to the same PixelBox object without any problem

◆ resize()

void Ogre::Image::resize ( ushort  width,
ushort  height,
Filter  filter = FILTER_BILINEAR 
)

Resize a 2D image, applying the appropriate filter.

◆ calculateSize()

static size_t Ogre::Image::calculateSize ( uint32  mipmaps,
uint32  faces,
uint32  width,
uint32  height,
uint32  depth,
PixelFormat  format 
)
static

Static function to calculate size in bytes from the number of mipmaps, faces and the dimensions.

◆ getFileExtFromMagic()

static String Ogre::Image::getFileExtFromMagic ( DataStreamPtr  stream)
static

Static function to get an image type string from a stream via magic numbers.


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