Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::D3DTexture Class Reference

Direct3D7-specific texture resource implementation. More...

#include <OgreD3D7Texture.h>

Inheritance diagram for Ogre::D3DTexture:

Ogre::Texture Ogre::Resource List of all members.

Public Methods

 D3DTexture (String name, IDirect3DDevice7 *lpDirect3dDevice, TextureUsage usage)
 D3DTexture (String name, IDirect3DDevice7 *lpDirect3dDevice, uint width, uint height, uint num_mips, PixelFormat format, TextureUsage usage)
 Constructor that can be used to manually create a texture and set its parameters. More...

virtual ~D3DTexture ()
virtual void load (void)
 Loads the resource, if it is not already. More...

virtual void loadImage (const Image &img)
 Loads the data from an image. More...

virtual void blitToTexture (const Image &src, unsigned uStartX, unsigned uStartY)
 Blits the contents of src on the texture. More...

virtual void blitImage (const Image &src, const Image::Rect imgRect, const Image::Rect texRect)
 Blits a rect from an image to the texture. More...

virtual void unload (void)
 Unloads the resource, but retains data to recreate. More...

virtual void copyToTexture (Texture *target)
 Copies (and maybe scales to fit) the contents of this texture to another texture. More...

LPDIRECTDRAWSURFACE7 getDDSurface (void)
 D3D-specific member that returns the underlying surface. More...

unsigned short getNumMipMaps (void)
 Gets the number of mipmaps to be used for this texture. More...

void setNumMipMaps (unsigned short num)
 Sets the number of mipmaps to be used for this texture. More...

float getGamma (void)
 Returns the gamma adjustment factor applied to this texture. More...

void setGamma (float g)
 Sets the gamma adjustment factor applied to this texture. More...

unsigned int getHeight (void)
 Returns the height of the texture. More...

unsigned int getWidth (void)
 Returns the width of the texture. More...

std::pair< uint, uint > getDimensions ()
 Returns both the width and height of the texture. More...

TextureUsage getUsage () const
void enable32Bit (bool setting=true)
virtual PixelFormat getFormat () const
 Returns the pixel format for the texture surface. More...

virtual bool hasAlpha (void)
 Returns true if the texture has an alpha layer. More...

virtual size_t getSize (void)
 Retrieves info about the size of the resource. More...

void touch (void)
 'Touches' the resource to indicate it has been used. More...

time_t getLastAccess (void) const
 Gets the last time the resource was 'touched'. More...

const String & getName (void) const
 Gets resource name. More...

bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise. More...

virtual void destroy ()
 A method to make the resource delete itself. More...


Protected Methods

void createSurface ()

Protected Attributes

IDirect3DDevice7 * mD3DDevice
 A pointer to the Direct3D device. More...

IDirectDrawSurface7 * mSurface
 Surface of the (first) device-specific texture. More...

unsigned long mHeight
unsigned long mWidth
unsigned short mNumMipMaps
float mGamma
PixelFormat mFormat
TextureUsage mUsage
unsigned short mSrcBpp
unsigned long mSrcWidth
unsigned long mSrcHeight
unsigned short mFinalBpp
bool mHasAlpha
String mName
bool mIsLoaded
time_t mLastAccess
size_t mSize

Detailed Description

Direct3D7-specific texture resource implementation.

Constructor & Destructor Documentation

Ogre::D3DTexture::D3DTexture (  String    name,
IDirect3DDevice7 *    lpDirect3dDevice,
TextureUsage    usage
) 
 

Ogre::D3DTexture::D3DTexture (  String    name,
IDirect3DDevice7 *    lpDirect3dDevice,
uint    width,
uint    height,
uint    num_mips,
PixelFormat    format,
TextureUsage    usage
) 
 

Constructor that can be used to manually create a texture and set its parameters.

Ogre::D3DTexture::~D3DTexture (    )  [virtual]
 

Member Function Documentation

void Ogre::D3DTexture::blitImage (  const Image &    src,
const Image::Rect    imgRect,
const Image::Rect    texRect
)  [virtual]
 

Blits a rect from an image to the texture.

Parameters:
src  The image with the source data.
imgRect  The data rect to be copied from the image.
texRect  The rect in which to copy the data in the texture.

Reimplemented from Ogre::Texture.

void Ogre::D3DTexture::blitToTexture (  const Image &    src,
unsigned    uStartX,
unsigned    uStartY
)  [virtual]
 

Blits the contents of src on the texture.

Deprecated:
This feature is superseded by the blitImage function.
Parameters:
src  the image with the source data

Implements Ogre::Texture.

void Ogre::D3DTexture::copyToTexture (  Texture *    target )  [virtual]
 

Copies (and maybe scales to fit) the contents of this texture to another texture.

Reimplemented from Ogre::Texture.

void Ogre::D3DTexture::createSurface (    )  [protected]
 

virtual void Ogre::Resource::destroy (  void    )  [inline, virtual, inherited]
 

A method to make the resource delete itself.

Note:
This exists because Resource objects could be created in other processes, and they need to be destroyed in the process that created them.

void Ogre::Texture::enable32Bit (  bool    setting = true )  [inline, inherited]
 

LPDIRECTDRAWSURFACE7 Ogre::D3DTexture::getDDSurface (  void    ) 
 

D3D-specific member that returns the underlying surface.

std::pair< uint, uint > Ogre::Texture::getDimensions (    )  [inline, inherited]
 

Returns both the width and height of the texture.

virtual PixelFormat Ogre::Texture::getFormat (    )  const [inline, virtual, inherited]
 

Returns the pixel format for the texture surface.

float Ogre::Texture::getGamma (  void    )  [inline, inherited]
 

Returns the gamma adjustment factor applied to this texture.

unsigned int Ogre::Texture::getHeight (  void    )  [inline, inherited]
 

Returns the height of the texture.

time_t Ogre::Resource::getLastAccess (  void    )  const [inline, inherited]
 

Gets the last time the resource was 'touched'.

const String& Ogre::Resource::getName (  void    )  const [inline, inherited]
 

Gets resource name.

Reimplemented in Ogre::Material.

unsigned short Ogre::Texture::getNumMipMaps (  void    )  [inline, inherited]
 

Gets the number of mipmaps to be used for this texture.

virtual size_t Ogre::Resource::getSize (  void    )  [inline, virtual, inherited]
 

Retrieves info about the size of the resource.

TextureUsage Ogre::Texture::getUsage (    )  const [inline, inherited]
 

unsigned int Ogre::Texture::getWidth (  void    )  [inline, inherited]
 

Returns the width of the texture.

virtual bool Ogre::Texture::hasAlpha (  void    )  [inline, virtual, inherited]
 

Returns true if the texture has an alpha layer.

bool Ogre::Resource::isLoaded (  void    )  const [inline, inherited]
 

Returns true if the Resource has been loaded, false otherwise.

void Ogre::D3DTexture::load (  void    )  [virtual]
 

Loads the resource, if it is not already.

Implements Ogre::Resource.

void Ogre::D3DTexture::loadImage (  const Image &    img )  [virtual]
 

Loads the data from an image.

Implements Ogre::Texture.

void Ogre::Texture::setGamma (  float    g )  [inline, inherited]
 

Sets the gamma adjustment factor applied to this texture.

Note:
Must be called before any 'load' method.

void Ogre::Texture::setNumMipMaps (  unsigned short    num )  [inline, inherited]
 

Sets the number of mipmaps to be used for this texture.

Note:
Must be set before calling any 'load' method.

void Ogre::Resource::touch (  void    )  [inline, inherited]
 

'Touches' the resource to indicate it has been used.

void Ogre::D3DTexture::unload (  void    )  [virtual]
 

Unloads the resource, but retains data to recreate.

Reimplemented from Ogre::Resource.

Member Data Documentation

IDirect3DDevice7* Ogre::D3DTexture::mD3DDevice [protected]
 

A pointer to the Direct3D device.

unsigned short Ogre::Texture::mFinalBpp [protected, inherited]
 

PixelFormat Ogre::Texture::mFormat [protected, inherited]
 

float Ogre::Texture::mGamma [protected, inherited]
 

bool Ogre::Texture::mHasAlpha [protected, inherited]
 

unsigned long Ogre::Texture::mHeight [protected, inherited]
 

bool Ogre::Resource::mIsLoaded [protected, inherited]
 

time_t Ogre::Resource::mLastAccess [protected, inherited]
 

String Ogre::Resource::mName [protected, inherited]
 

unsigned short Ogre::Texture::mNumMipMaps [protected, inherited]
 

size_t Ogre::Resource::mSize [protected, inherited]
 

unsigned short Ogre::Texture::mSrcBpp [protected, inherited]
 

unsigned long Ogre::Texture::mSrcHeight [protected, inherited]
 

unsigned long Ogre::Texture::mSrcWidth [protected, inherited]
 

IDirectDrawSurface7* Ogre::D3DTexture::mSurface [protected]
 

Surface of the (first) device-specific texture.

TextureUsage Ogre::Texture::mUsage [protected, inherited]
 

unsigned long Ogre::Texture::mWidth [protected, inherited]
 

Copyright © 2002 by The OGRE Team