Crazy Eddies GUI System  0.6.2
Public Member Functions | Friends | List of all members
CEGUI::DirectX81Texture Class Reference

Texture class that is created by DirectX81Renderer objects. More...

+ Inheritance diagram for CEGUI::DirectX81Texture:
+ Collaboration diagram for CEGUI::DirectX81Texture:

Public Member Functions

virtual ushort getWidth (void) const
 Returns the current pixel width of the texture. More...
 
virtual ushort getHeight (void) const
 Returns the current pixel height of the texture. More...
 
virtual ushort getOriginalWidth (void) const
 Returns the original pixel width of the data loaded into the texture. More...
 
virtual ushort getOriginalHeight (void) const
 Returns the original pixel height of the data loaded into the texture. More...
 
virtual void loadFromFile (const String &filename, const String &resourceGroup)
 Loads the specified image file into the texture. The texture is resized as required to hold the image. More...
 
virtual void loadFromMemory (const void *buffPtr, uint buffWidth, uint buffHeight, PixelFormat pixelFormat)
 Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image. More...
 
LPDIRECT3DTEXTURE8 getD3DTexture (void) const
 Return a pointer to the internal Direct3DTexture8 object. More...
 
void setD3DTextureSize (uint size)
 set the size of the internal D3D texture. Previous D3D texture is lost. More...
 
virtual void preD3DReset (void)
 Direct3D support method that must be called prior to a Reset call on the Direct3DDevice; this is required so that the GUI renderer can release any unmanaged D3D resources as needed for the device reset to succeed. More...
 
virtual void postD3DReset (void)
 Direct3D support method that must be called after a Reset call on the Direct3DDevice; this is required so that the GUI renderer can rebuild any unmanaged D3D resources after the device has been reset. More...
 
- Public Member Functions inherited from CEGUI::Texture
virtual float getXScale (void) const
 Returns the current scale used for the width of the texture. More...
 
virtual float getYScale (void) const
 Returns the current scale used for the height of the texture. More...
 
RenderergetRenderer (void) const
 Return a pointer to the Renderer object that created and owns this Texture. More...
 

Friends

TextureDirectX81Renderer::createTexture (void)
 
TextureDirectX81Renderer::createTexture (const String &filename, const String &resourceGroup)
 
TextureDirectX81Renderer::createTexture (float size)
 
void DirectX81Renderer::destroyTexture (Texture *texture)
 

Additional Inherited Members

- Public Types inherited from CEGUI::Texture
enum  PixelFormat { PF_RGB, PF_RGBA }
 Enum containing the list of supported pixel formats that can be passed to loadFromMemory. More...
 
- Protected Member Functions inherited from CEGUI::Texture
 Texture (Renderer *owner)
 Constructor for Texture base class. This is never called by client code.
 
virtual ~Texture (void)
 Destructor for Texture base class. This is never called by client code.
 

Detailed Description

Texture class that is created by DirectX81Renderer objects.

Member Function Documentation

LPDIRECT3DTEXTURE8 CEGUI::DirectX81Texture::getD3DTexture ( void  ) const
inline

Return a pointer to the internal Direct3DTexture8 object.

Returns
Pointer to the IDirect3DTexture8 interface currently being used by this Texture object
virtual ushort CEGUI::DirectX81Texture::getHeight ( void  ) const
inlinevirtual

Returns the current pixel height of the texture.

Returns
ushort value that is the current height of the texture in pixels

Implements CEGUI::Texture.

virtual ushort CEGUI::DirectX81Texture::getOriginalHeight ( void  ) const
inlinevirtual

Returns the original pixel height of the data loaded into the texture.

Returns
ushort value that is the original height, in pixels, of the data last loaded into the texture.
Note
for compatibility reason this method is optional the auto scale issue mantis ticket # 0000045 is not fixed for renderer that do not handle this.

Reimplemented from CEGUI::Texture.

virtual ushort CEGUI::DirectX81Texture::getOriginalWidth ( void  ) const
inlinevirtual

Returns the original pixel width of the data loaded into the texture.

Returns
ushort value that is the original width, in pixels, of the data last loaded into the texture.
Note
for compatibility reason this method is optional the auto scale issue mantis ticket # 0000045 is not fixed for renderer that do not handle this.

Reimplemented from CEGUI::Texture.

virtual ushort CEGUI::DirectX81Texture::getWidth ( void  ) const
inlinevirtual

Returns the current pixel width of the texture.

Returns
ushort value that is the current width of the texture in pixels

Implements CEGUI::Texture.

void CEGUI::DirectX81Texture::loadFromFile ( const String filename,
const String resourceGroup 
)
virtual

Loads the specified image file into the texture. The texture is resized as required to hold the image.

Parameters
filenameThe filename of the image file that is to be loaded into the texture
resourceGroupResource group identifier passed to the resource provider.
Returns
Nothing.

Implements CEGUI::Texture.

References CEGUI::RawDataContainer::getDataPtr(), CEGUI::Texture::getRenderer(), CEGUI::System::getResourceProvider(), CEGUI::System::getSingleton(), CEGUI::RawDataContainer::getSize(), CEGUI::ResourceProvider::loadRawDataContainer(), and CEGUI::ResourceProvider::unloadRawDataContainer().

Referenced by CEGUI::DirectX81Renderer::createTexture(), and postD3DReset().

void CEGUI::DirectX81Texture::loadFromMemory ( const void *  buffPtr,
uint  buffWidth,
uint  buffHeight,
Texture::PixelFormat  pixFormat 
)
virtual

Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image.

Parameters
buffPtrPointer to the buffer containing the image data
buffWidthWidth of the buffer (in pixels as specified by pixelFormat )
buffHeightHeight of the buffer (in pixels as specified by pixelFormat )
pixelFormatPixelFormat value describing the format contained in buffPtr
Returns
Nothing.

Implements CEGUI::Texture.

References CEGUI::Texture::getRenderer(), CEGUI::Texture::PF_RGB, and CEGUI::Texture::PF_RGBA.

void CEGUI::DirectX81Texture::postD3DReset ( void  )
virtual

Direct3D support method that must be called after a Reset call on the Direct3DDevice; this is required so that the GUI renderer can rebuild any unmanaged D3D resources after the device has been reset.

Note
You do not need to call this on DirectX81Texture objects created via the DirectX81Renderer object; for such textures the method is called by the system when you call the DirectX81Renderer::postD3DReset method.

References loadFromFile().

void CEGUI::DirectX81Texture::preD3DReset ( void  )
virtual

Direct3D support method that must be called prior to a Reset call on the Direct3DDevice; this is required so that the GUI renderer can release any unmanaged D3D resources as needed for the device reset to succeed.

Note
You do not need to call this on DirectX81Texture objects created via the DirectX81Renderer object; for such textures the method is called by the system when you call the DirectX81Renderer::preD3DReset method.
void CEGUI::DirectX81Texture::setD3DTextureSize ( uint  size)

set the size of the internal D3D texture. Previous D3D texture is lost.

Parameters
sizepixel size of the new internal texture. This will be rounded up to a power of 2.
Returns
Nothing.

References CEGUI::Texture::getRenderer().

Referenced by CEGUI::DirectX81Renderer::createTexture().