Crazy Eddie's GUI System  ${CEGUI_VERSION}
Texture_wrapper Struct Reference
+ Inheritance diagram for Texture_wrapper:
+ Collaboration diagram for Texture_wrapper:

Public Member Functions

virtual void blitFromMemory (void const *sourceData,::CEGUI::Rectf const &area)
 
virtual void blitToMemory (void *targetData)
 Performs a complete blit from the texture surface to memory. More...
 
virtual ::CEGUI::String const & getName () const
 Returns the name given to the texture when it was created. More...
 
virtual ::CEGUI::Sizef const & getOriginalDataSize () const
 Returns the original pixel size of the data loaded into the texture. More...
 
virtual ::CEGUI::Sizef const & getSize () const
 Returns the current pixel size of the texture. More...
 
virtual ::CEGUI::Vector2f const & getTexelScaling () const
 Returns pixel to texel scale values that should be used for converting pixel values to texture co-ords. More...
 
virtual bool isPixelFormatSupported (::CEGUI::Texture::PixelFormat const fmt) const
 
virtual void loadFromFile (::CEGUI::String const &filename,::CEGUI::String const &resourceGroup)
 
virtual void loadFromMemory (void const *buffer,::CEGUI::Sizef const &buffer_size,::CEGUI::Texture::PixelFormat pixel_format)
 
- Public Member Functions inherited from CEGUI::Texture
virtual ~Texture ()
 Destructor for Texture base class.
 
virtual void loadFromFile (const String &filename, const String &resourceGroup)=0
 Loads the specified image file into the texture. The texture is resized as required to hold the image. More...
 
virtual void loadFromMemory (const void *buffer, const Sizef &buffer_size, PixelFormat pixel_format)=0
 Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image. More...
 
virtual void blitFromMemory (const void *sourceData, const Rectf &area)=0
 Performs an area memory blit to the texture. More...
 
virtual bool isPixelFormatSupported (const PixelFormat fmt) const =0
 Return whether the specified pixel format is supported by the system for the CEGUI::Texture implementation. More...
 
virtual ~Texture ()
 Destructor for Texture base class.
 
virtual void loadFromFile (const String &filename, const String &resourceGroup)=0
 Loads the specified image file into the texture. The texture is resized as required to hold the image. More...
 
virtual void loadFromMemory (const void *buffer, const Sizef &buffer_size, PixelFormat pixel_format)=0
 Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image. More...
 
virtual void blitFromMemory (const void *sourceData, const Rectf &area)=0
 Performs an area memory blit to the texture. More...
 
virtual bool isPixelFormatSupported (const PixelFormat fmt) const =0
 Return whether the specified pixel format is supported by the system for the CEGUI::Texture implementation. More...
 

Additional Inherited Members

- Public Types inherited from CEGUI::Texture
enum  PixelFormat {
  PF_RGB, PF_RGBA, PF_RGBA_4444, PF_RGB_565,
  PF_PVRTC2, PF_PVRTC4, PF_RGB_DXT1, PF_RGBA_DXT1,
  PF_RGBA_DXT3, PF_RGBA_DXT5, PF_RGB, PF_RGBA,
  PF_RGBA_4444, PF_RGB_565, PF_PVRTC2, PF_PVRTC4,
  PF_RGB_DXT1, PF_RGBA_DXT1, PF_RGBA_DXT3, PF_RGBA_DXT5
}
 Enumerated type containing the supported pixel formats that can be passed to loadFromMemory. More...
 
enum  PixelFormat {
  PF_RGB, PF_RGBA, PF_RGBA_4444, PF_RGB_565,
  PF_PVRTC2, PF_PVRTC4, PF_RGB_DXT1, PF_RGBA_DXT1,
  PF_RGBA_DXT3, PF_RGBA_DXT5, PF_RGB, PF_RGBA,
  PF_RGBA_4444, PF_RGB_565, PF_PVRTC2, PF_PVRTC4,
  PF_RGB_DXT1, PF_RGBA_DXT1, PF_RGBA_DXT3, PF_RGBA_DXT5
}
 Enumerated type containing the supported pixel formats that can be passed to loadFromMemory. More...
 

Member Function Documentation

virtual void Texture_wrapper::blitToMemory ( void *  targetData)
inlinevirtual

Performs a complete blit from the texture surface to memory.

Parameters
targetDatathe buffer where the target is stored
Note
You have to (correctly) preallocate the target buffer!

Implements CEGUI::Texture.

virtual ::CEGUI::String const& Texture_wrapper::getName ( ) const
inlinevirtual

Returns the name given to the texture when it was created.

Returns
Reference to a String object that holds the name of the texture.

Implements CEGUI::Texture.

virtual ::CEGUI::Sizef const& Texture_wrapper::getOriginalDataSize ( ) const
inlinevirtual

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

Returns
reference to a Size object that describes the original size, in pixels, of the data loaded into the texture.

Implements CEGUI::Texture.

virtual ::CEGUI::Sizef const& Texture_wrapper::getSize ( ) const
inlinevirtual

Returns the current pixel size of the texture.

Returns
Reference to a Size object that describes the size of the texture in pixels.

Implements CEGUI::Texture.

virtual ::CEGUI::Vector2f const& Texture_wrapper::getTexelScaling ( ) const
inlinevirtual

Returns pixel to texel scale values that should be used for converting pixel values to texture co-ords.

Returns
Reference to a Vector2 object that describes the scaling values required to accurately map pixel positions to texture co-ordinates.

Implements CEGUI::Texture.