CrystalSpace

Public API Reference

csTextureHandle Class Reference

This class is the top-level representation of a texture. More...

#include <csplugincommon/render3d/txtmgr.h>

Inherits scfImplementation1< csTextureHandle, iTextureHandle >.

List of all members.

Public Member Functions

void AdjustSizePo2 (int width, int height, int depth, int &newwidth, int &newheight, int &newdepth)
 Adjusts the textures size, to ensure some restrictions like power of two dimension are met.
virtual bool GetAlphaMap ()
 Query if the texture has an alpha channel.
int GetFlags () const
 --------------------- iTextureHandle implementation ----------------------
virtual void GetKeyColor (uint8 &r, uint8 &g, uint8 &b) const
 Get the transparent color.
virtual bool GetKeyColor () const
 Get the transparent status (false if no transparency, true if transparency).
virtual void * GetPrivateObject ()
 Get the csTextureHandle object associated with the texture handle.
virtual void SetKeyColor (uint8 red, uint8 green, uint8 blue)
 Set the transparent color.
virtual void SetKeyColor (bool Enable)
 Enable transparent color.

Static Public Member Functions

static void CalculateNextBestPo2Size (int flags, const int orgDim, int &newDim)
 Given a texture width and height, it tries to 'guesstimate' the po2 size that causes the least quality reduction: it calculates how many rows/columns would be added/removed when sizing up/down, and takes the one with the smaller number.

Protected Attributes

int flags
 Texture usage flags: 2d/3d/etc.
csRef< csTextureManagertexman
 Parent texture manager.
bool transp
 Does color 0 mean "transparent" for this texture?
csRGBpixel transp_color
 The transparent color.

Detailed Description

This class is the top-level representation of a texture.

It contains a number of csTexture objects that represents each a single image. A csTexture object is created for each mipmap and for the 2D texture. This class is responsible for creating these textures and filling them with the correct info. The csTextureHandle class is private to the 3D driver, the driver clients see just the iTextureHandle interface.

The handle is initialized by giving the 3D driver a iImage object. Later the renderer will create mipmaps and 2D textures are created. The texture manager will release its reference to the image when no longer needed.

Definition at line 60 of file txtmgr.h.


Member Function Documentation

void csTextureHandle::AdjustSizePo2 ( int  width,
int  height,
int  depth,
int &  newwidth,
int &  newheight,
int &  newdepth 
)

Adjusts the textures size, to ensure some restrictions like power of two dimension are met.

static void csTextureHandle::CalculateNextBestPo2Size ( int  flags,
const int  orgDim,
int &  newDim 
) [static]

Given a texture width and height, it tries to 'guesstimate' the po2 size that causes the least quality reduction: it calculates how many rows/columns would be added/removed when sizing up/down, and takes the one with the smaller number.

In case of a tie, it'll size up.

virtual bool csTextureHandle::GetAlphaMap (  )  [inline, virtual]

Query if the texture has an alpha channel.

This depends both on whenever the original image had an alpha channel and of the fact whenever the renderer supports alpha maps at all.

Definition at line 118 of file txtmgr.h.

int csTextureHandle::GetFlags (  )  const [inline]

--------------------- iTextureHandle implementation ----------------------

Definition at line 92 of file txtmgr.h.

virtual bool csTextureHandle::GetKeyColor (  )  const [virtual]

Get the transparent status (false if no transparency, true if transparency).

virtual void csTextureHandle::GetKeyColor ( uint8 r,
uint8 g,
uint8 b 
) const [virtual]

Get the transparent color.

virtual void* csTextureHandle::GetPrivateObject (  )  [inline, virtual]

Get the csTextureHandle object associated with the texture handle.

Definition at line 110 of file txtmgr.h.

virtual void csTextureHandle::SetKeyColor ( bool  Enable  )  [virtual]

Enable transparent color.

virtual void csTextureHandle::SetKeyColor ( uint8  red,
uint8  green,
uint8  blue 
) [virtual]

Set the transparent color.


Member Data Documentation

int csTextureHandle::flags [protected]

Texture usage flags: 2d/3d/etc.

Definition at line 68 of file txtmgr.h.

Parent texture manager.

Definition at line 65 of file txtmgr.h.

bool csTextureHandle::transp [protected]

Does color 0 mean "transparent" for this texture?

Definition at line 71 of file txtmgr.h.

The transparent color.

Definition at line 73 of file txtmgr.h.


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

Generated for Crystal Space 1.4.1 by doxygen 1.7.1