Crazy Eddie's GUI System  0.8.7
CEGUI::Direct3D11Texture Class Reference

Texture implementation for the Direct3D11Renderer. More...

+ Inheritance diagram for CEGUI::Direct3D11Texture:
+ Collaboration diagram for CEGUI::Direct3D11Texture:

Public Member Functions

void setDirect3DTexture (ID3D11Texture2D *tex)
 set the D3D10 texture that this Texture is based on to the specified texture.
 
ID3D11Texture2D * getDirect3DTexture () const
 Return the internal D3D10 texture used by this Texture object. More...
 
ID3D11ShaderResourceView * getDirect3DShaderResourceView () const
 Return the internal D3D10 shader resource view for the texture. More...
 
void setOriginalDataSize (const Sizef &sz)
 Sets what the texture should consider as the original data size. More...
 
const StringgetName () const
 Returns the name given to the texture when it was created. More...
 
const SizefgetSize () const
 Returns the current pixel size of the texture. More...
 
const SizefgetOriginalDataSize () const
 Returns the original pixel size of the data loaded into the texture. More...
 
const Vector2fgetTexelScaling () const
 Returns pixel to texel scale values that should be used for converting pixel values to texture co-ords. More...
 
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...
 
void loadFromMemory (const void *buffer, const Sizef &buffer_size, PixelFormat pixel_format)
 Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image. More...
 
void blitFromMemory (const void *sourceData, const Rectf &area)
 Performs an area memory blit to the texture. More...
 
void blitToMemory (void *targetData)
 Performs a complete blit from the texture surface to memory. More...
 
bool isPixelFormatSupported (const PixelFormat fmt) const
 Return whether the specified pixel format is supported by the system for the CEGUI::Texture implementation. More...
 
- Public Member Functions inherited from CEGUI::Texture
virtual ~Texture ()
 Destructor for Texture base class.
 

Protected Member Functions

 Direct3D11Texture (IDevice11 &device, const String &name)
 Basic constructor.
 
 Direct3D11Texture (IDevice11 &device, const String &name, const String &filename, const String &resourceGroup)
 Construct texture from an image file.
 
 Direct3D11Texture (IDevice11 &device, const String &name, const Sizef &sz)
 Construct texture with a given size.
 
 Direct3D11Texture (IDevice11 &device, const String &name, ID3D11Texture2D *tex)
 Construct texture that wraps an existing D3D10 texture.
 
virtual ~Direct3D11Texture ()
 Destructor.
 
void cleanupDirect3D11Texture ()
 clean up the internal texture.
 
void updateCachedScaleValues ()
 updates cached scale value used to map pixels to texture co-ords.
 
void updateTextureSize ()
 set d_size to actual texture size (d_dataSize is used if query fails)
 
void initialiseShaderResourceView ()
 creates shader resource view for the current D3D texture
 

Protected Attributes

IDevice11d_device
 D3D device used to do the business.
 
ID3D11Texture2D * d_texture
 The D3D 10 texture we're wrapping.
 
ID3D11ShaderResourceView * d_resourceView
 Shader resource view for the texture.
 
Sizef d_size
 Size of the texture.
 
Sizef d_dataSize
 original pixel of size data loaded into texture
 
Vector2f d_texelScaling
 cached pixel to texel mapping scale values.
 
const String d_name
 The name we were created with.
 

Friends

TextureDirect3D11Renderer::createTexture (const String &)
 
TextureDirect3D11Renderer::createTexture (const String &, const String &, const String &)
 
TextureDirect3D11Renderer::createTexture (const String &, const Sizef &)
 
void Direct3D11Renderer::destroyTexture (Texture &)
 
void Direct3D11Renderer::destroyTexture (const String &)
 

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
}
 Enumerated type containing the supported pixel formats that can be passed to loadFromMemory. More...
 

Detailed Description

Texture implementation for the Direct3D11Renderer.

Member Function Documentation

void CEGUI::Direct3D11Texture::blitFromMemory ( const void *  sourceData,
const Rectf area 
)
virtual

Performs an area memory blit to the texture.

Parameters
sourceDatainput data, the size must match area described by the given Rect
areaarea where the blit will happen
Note
The pixel format must match current Texture's pixel format!

Implements CEGUI::Texture.

void CEGUI::Direct3D11Texture::blitToMemory ( void *  targetData)
virtual

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.

ID3D11ShaderResourceView* CEGUI::Direct3D11Texture::getDirect3DShaderResourceView ( ) const

Return the internal D3D10 shader resource view for the texture.

Returns
Pointer to the ID3D10ShaderResourceView interface.
ID3D11Texture2D* CEGUI::Direct3D11Texture::getDirect3DTexture ( ) const

Return the internal D3D10 texture used by this Texture object.

Returns
Pointer to the D3D10 texture interface that this object is using.
const String& CEGUI::Direct3D11Texture::getName ( ) const
virtual

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.

const Sizef& CEGUI::Direct3D11Texture::getOriginalDataSize ( ) const
virtual

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.

const Sizef& CEGUI::Direct3D11Texture::getSize ( ) const
virtual

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.

const Vector2f& CEGUI::Direct3D11Texture::getTexelScaling ( ) const
virtual

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.

bool CEGUI::Direct3D11Texture::isPixelFormatSupported ( const PixelFormat  fmt) const
virtual

Return whether the specified pixel format is supported by the system for the CEGUI::Texture implementation.

The result of this call will vary according to the implementaion API and the capabilities of the hardware.

Note
Whether the CEGUI system as a whole will make use of support for any given pixel format will depend upon that format being recognised and supported by both the renderer module implementation and the ImageCodec module that is used to load texture data.
Parameters
fmtOne of the PixelFormat enumerated values specifying the pixel format that is to be tested.
Returns
  • true if the specified PixelFormat is supported.
  • false if the specified PixelFormat is not supported.

Implements CEGUI::Texture.

void CEGUI::Direct3D11Texture::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 to be passed to the resource provider when loading the image file.
Returns
Nothing.

Implements CEGUI::Texture.

void CEGUI::Direct3D11Texture::loadFromMemory ( const void *  buffer,
const Sizef buffer_size,
PixelFormat  pixel_format 
)
virtual

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

Parameters
bufferPointer to the buffer containing the image data.
buffer_sizeSize of the buffer (in pixels as specified by pixelFormat)
pixel_formatPixelFormat value describing the format contained in buffPtr.
Returns
Nothing.

Implements CEGUI::Texture.

void CEGUI::Direct3D11Texture::setOriginalDataSize ( const Sizef sz)

Sets what the texture should consider as the original data size.

Note
This also causes the texel scaling values to be updated.