OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::D3D9Texture Class Reference

#include <OgreD3D9Texture.h>

+ Inheritance diagram for Ogre::D3D9Texture:
+ Collaboration diagram for Ogre::D3D9Texture:

Classes

struct  TextureResources
 

Public Types

enum  LoadingState {
  LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING,
  LOADSTATE_PREPARED, LOADSTATE_PREPARING
}
 Enum identifying the loading state of the resource. More...
 

Public Member Functions

 D3D9Texture (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader)
 constructor More...
 
 ~D3D9Texture ()
 destructor More...
 
virtual void _dirtyState ()
 Manually mark the state of this resource as having been changed. More...
 
virtual void _fireLoadingComplete (bool wasBackgroundLoaded)
 Firing of loading complete event. More...
 
virtual void _firePreparingComplete (bool wasBackgroundLoaded)
 Firing of preparing complete event. More...
 
virtual void _fireUnloadingComplete (void)
 Firing of unloading complete event. More...
 
virtual void _loadImages (const ConstImagePtrList &images)
 Internal method to load the texture from a set of images. More...
 
virtual void _notifyOrigin (const String &origin)
 Notify this resource of it's origin. More...
 
virtual void addListener (Listener *lis)
 Register a listener on this resource. More...
 
virtual void changeGroupOwnership (const String &newGroup)
 Change the resource group ownership of a Resource. More...
 
virtual void convertToImage (Image &destImage, bool includeMipMaps=false)
 Populate an Image with the contents of this texture. More...
 
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
void copyToTexture (TexturePtr &target)
 overridden from Texture More...
 
virtual void escalateLoading ()
 Escalates the loading of a background loaded resource. More...
 
HardwarePixelBufferSharedPtr getBuffer (size_t face, size_t mipmap)
 Return hardware pixel buffer for a surface. More...
 
virtual ResourceManagergetCreator (void)
 Gets the manager which created this resource. More...
 
IDirect3DCubeTexture9 * getCubeTexture ()
 retrieves a pointer to the cube texture More...
 
virtual void getCustomAttribute (const String &name, void *pData)
 Retrieve a platform or API-specific piece of information from this texture. More...
 
virtual uint32 getDepth (void) const
 Returns the depth of the texture (only applicable for 3D textures). More...
 
virtual ushort getDesiredFloatBitDepth (void) const
 gets desired bit depth for float pixel format textures. More...
 
virtual PixelFormat getDesiredFormat (void) const
 Returns the desired pixel format for the texture surface. More...
 
virtual ushort getDesiredIntegerBitDepth (void) const
 gets desired bit depth for integer pixel format textures. More...
 
virtual PixelFormat getFormat () const
 Returns the pixel format for the texture surface. More...
 
virtual uint getFSAA () const
 Get the level of multisample AA to be used if this texture is a rendertarget. More...
 
virtual const StringgetFSAAHint () const
 Get the multisample AA hint if this texture is a rendertarget. More...
 
virtual float getGamma (void) const
 Returns the gamma adjustment factor applied to this texture on loading. More...
 
virtual const StringgetGroup (void) const
 Gets the group which this resource is a member of. More...
 
virtual ResourceHandle getHandle (void) const
 
virtual uint32 getHeight (void) const
 Returns the height of the texture. More...
 
virtual LoadingState getLoadingState () const
 Returns the current loading state. More...
 
virtual bool getMipmapsHardwareGenerated (void) const
 Are mipmaps hardware generated? More...
 
virtual const StringgetName (void) const
 Gets resource name. More...
 
IDirect3DTexture9 * getNormTexture ()
 retrieves a pointer to the normal 1D/2D texture More...
 
virtual size_t getNumFaces () const
 Return the number of faces this texture has. More...
 
virtual uint8 getNumMipmaps (void) const
 Gets the number of mipmaps to be used for this texture. More...
 
virtual const StringgetOrigin (void) const
 Get the origin of this resource, e.g. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
virtual String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
virtual size_t getSize (void) const
 Retrieves info about the size of the resource. More...
 
virtual uint32 getSrcDepth (void) const
 Returns the original depth of the input texture (only applicable for 3D textures). More...
 
virtual PixelFormat getSrcFormat (void) const
 Returns the pixel format of the original input texture (may differ due to hardware requirements and pixel format conversion). More...
 
virtual uint32 getSrcHeight (void) const
 Returns the height of the original input texture (may differ due to hardware requirements). More...
 
virtual uint32 getSrcWidth (void) const
 Returns the width of the original input texture (may differ due to hardware requirements). More...
 
virtual size_t getStateCount () const
 Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More...
 
IDirect3DBaseTexture9 * getTexture ()
 retrieves a pointer to the actual texture More...
 
virtual TextureType getTextureType (void) const
 Gets the type of texture. More...
 
virtual bool getTreatLuminanceAsAlpha (void) const
 Gets whether luminace pixel format will treated as alpha format when load this texture. More...
 
virtual int getUsage () const
 Returns the TextureUsage identifier for this Texture. More...
 
virtual uint32 getWidth (void) const
 Returns the width of the texture. More...
 
virtual bool hasAlpha (void) const
 Returns true if the texture has an alpha layer. More...
 
virtual bool isBackgroundLoaded (void) const
 Returns whether this Resource has been earmarked for background loading. More...
 
virtual bool isHardwareGammaEnabled () const
 Gets whether this texture will be set up so that on sampling it, hardware gamma correction is applied. More...
 
bool isHardwareGammaReadToBeUsed () const
 Indicates whether the hardware gamma is actually enabled and supported. More...
 
virtual bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise. More...
 
virtual bool isLoading () const
 Returns whether the resource is currently in the process of background loading. More...
 
virtual bool isManuallyLoaded (void) const
 Is this resource manually loaded? More...
 
virtual bool isPrepared (void) const
 Returns true if the Resource has been prepared, false otherwise. More...
 
virtual bool isReloadable (void) const
 Returns true if the Resource is reloadable, false otherwise. More...
 
virtual void load (bool backgroundThread=false)
 Loads the resource, if it is not already. More...
 
virtual void loadImage (const Image &img)
 Loads the data from an image. More...
 
virtual void loadRawData (DataStreamPtr &stream, ushort uWidth, ushort uHeight, PixelFormat eFormat)
 Loads the data from a raw stream. More...
 
virtual void notifyOnDeviceCreate (IDirect3DDevice9 *d3d9Device)
 
virtual void notifyOnDeviceDestroy (IDirect3DDevice9 *d3d9Device)
 
virtual void notifyOnDeviceLost (IDirect3DDevice9 *d3d9Device)
 
virtual void notifyOnDeviceReset (IDirect3DDevice9 *d3d9Device)
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void prepare (bool backgroundThread=false)
 Prepares the resource for load, if it is not already. More...
 
virtual void reload (void)
 Reloads the resource, if it is already loaded. More...
 
virtual void removeListener (Listener *lis)
 Remove a listener on this resource. More...
 
virtual void setBackgroundLoaded (bool bl)
 Tells the resource whether it is background loaded or not. More...
 
virtual void setDepth (uint32 d)
 Set the depth of the texture (only applicable for 3D textures); can only do this before load();. More...
 
virtual void setDesiredBitDepths (ushort integerBits, ushort floatBits)
 Sets desired bit depth for integer and float pixel format. More...
 
virtual void setDesiredFloatBitDepth (ushort bits)
 Sets desired bit depth for float pixel format textures. More...
 
virtual void setDesiredIntegerBitDepth (ushort bits)
 Sets desired bit depth for integer pixel format textures. More...
 
virtual void setFormat (PixelFormat pf)
 Sets the pixel format for the texture surface; can only be set before load(). More...
 
virtual void setFSAA (uint fsaa, const String &fsaaHint)
 Set the level of multisample AA to be used if this texture is a rendertarget. More...
 
virtual void setGamma (float g)
 Sets the gamma adjustment factor applied to this texture on loading the data. More...
 
virtual void setHardwareGammaEnabled (bool enabled)
 Sets whether this texture will be set up so that on sampling it, hardware gamma correction is applied. More...
 
virtual void setHeight (uint32 h)
 Set the height of the texture; can only do this before load();. More...
 
virtual void setNumMipmaps (uint8 num)
 Sets the number of mipmaps to be used for this texture. More...
 
virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
virtual void setTextureType (TextureType ttype)
 Sets the type of texture; can only be changed before load() More...
 
virtual void setTreatLuminanceAsAlpha (bool asAlpha)
 Sets whether luminace pixel format will treated as alpha format when load this texture. More...
 
virtual void setUsage (int u)
 Sets the TextureUsage identifier for this Texture; only useful before load() More...
 
virtual void setWidth (uint32 w)
 Set the width of the texture; can only do this before load();. More...
 
virtual void touch (void)
 'Touches' the resource to indicate it has been used. More...
 
virtual void unload (void)
 Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...
 
bool useDefaultPool ()
 Will this texture need to be in the default pool? More...
 

Static Public Member Functions

static void cleanupDictionary ()
 Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...
 
static void lockDeviceAccess ()
 
static void unlockDeviceAccess ()
 

Public Attributes

 OGRE_AUTO_MUTEX
 

Protected Types

typedef
DeviceToTextureResourcesMap::iterator 
DeviceToTextureResourcesIterator
 
typedef map< IDirect3DDevice9
*, TextureResources * >::type 
DeviceToTextureResourcesMap
 
typedef set< Listener * >::type ListenerList
 
typedef SharedPtr< vector
< MemoryDataStreamPtr >::type > 
LoadedStreams
 
typedef vector
< HardwarePixelBufferSharedPtr >
::type 
SurfaceList
 Vector of pointers to subsurfaces. More...
 

Protected Member Functions

bool _canAutoGenMipmaps (IDirect3DDevice9 *d3d9Device, DWORD srcUsage, D3DRESOURCETYPE srcType, D3DFORMAT srcFormat)
 internal method, return true if the device/texture combination can auto gen. mip maps More...
 
bool _canUseDynamicTextures (IDirect3DDevice9 *d3d9Device, DWORD srcUsage, D3DRESOURCETYPE srcType, D3DFORMAT srcFormat)
 internal method, return true if the device/texture combination can use dynamic textures More...
 
bool _canUseHardwareGammaCorrection (IDirect3DDevice9 *d3d9Device, DWORD srcUsage, D3DRESOURCETYPE srcType, D3DFORMAT srcFormat, bool forwriting)
 internal method, return true if the device/texture combination can use hardware gamma More...
 
D3DFORMAT _chooseD3DFormat (IDirect3DDevice9 *d3d9Device)
 internal method, return a D3D pixel format for texture creation More...
 
void _createCubeTex (IDirect3DDevice9 *d3d9Device)
 internal method, create a blank cube texture More...
 
void _createNormTex (IDirect3DDevice9 *d3d9Device)
 internal method, create a blank normal 1D/2D texture More...
 
void _createSurfaceList (IDirect3DDevice9 *d3d9Device, TextureResources *textureResources)
 internal method, create D3D9HardwarePixelBuffers for every face and mipmap level. More...
 
void _createVolumeTex (IDirect3DDevice9 *d3d9Device)
 internal method, create a blank cube texture More...
 
D3DTEXTUREFILTERTYPE _getBestFilterMethod (IDirect3DDevice9 *d3d9Device)
 internal method, return the best by hardware supported filter method More...
 
String _getCubeFaceName (unsigned char face) const
 internal method, the cube map face name for the spec. face index More...
 
void _loadCubeTex (IDirect3DDevice9 *d3d9Device, const LoadedStreams &loadedStreams)
 internal method, load a cube texture More...
 
void _loadNormTex (IDirect3DDevice9 *d3d9Device, const LoadedStreams &loadedStreams)
 internal method, load a normal texture More...
 
void _loadVolumeTex (IDirect3DDevice9 *d3d9Device, const LoadedStreams &loadedStreams)
 internal method, load a volume texture More...
 
LoadedStreams _prepareCubeTex ()
 internal method, prepare a cube texture More...
 
LoadedStreams _prepareNormTex ()
 internal method, prepare a normal texture More...
 
LoadedStreams _prepareVolumeTex ()
 internal method, prepare a volume texture More...
 
void _setFinalAttributes (IDirect3DDevice9 *d3d9Device, TextureResources *textureResources, unsigned long width, unsigned long height, unsigned long depth, PixelFormat format)
 internal method, set Texture class final texture protected attributes More...
 
void _setSrcAttributes (unsigned long width, unsigned long height, unsigned long depth, PixelFormat format)
 internal method, set Texture class source image protected attributes More...
 
TextureResourcesallocateTextureResources (IDirect3DDevice9 *d3d9Device)
 allocates new texture resources structure attached to the given device. More...
 
size_t calculateSize (void) const
 Calculate the size of a resource; this will only be called after 'load'. More...
 
void createInternalResources (void)
 Creates the internal texture resources for this texture. More...
 
void createInternalResourcesImpl (void)
 Implementation of creating internal texture resources. More...
 
void createInternalResourcesImpl (IDirect3DDevice9 *d3d9Device)
 Creates this texture resources on the specified device. More...
 
bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
 
void createTextureResources (IDirect3DDevice9 *d3d9Device)
 creates this texture resources according to the current settings. More...
 
void determinePool ()
 
void freeInternalResources (void)
 Frees internal texture resources for this texture. More...
 
void freeInternalResourcesImpl (void)
 free internal resources More...
 
void freeTextureResources (IDirect3DDevice9 *d3d9Device, TextureResources *textureResources)
 frees the given texture resources. More...
 
String getSourceFileType () const
 Identify the source file type as a string, either from the extension or from a magic number. More...
 
TextureResourcesgetTextureResources (IDirect3DDevice9 *d3d9Device)
 gets the texture resources attached to the given device. More...
 
void loadImpl ()
 overridden from Resource More...
 
void loadImpl (IDirect3DDevice9 *d3d9Device)
 Loads this texture into the specified device. More...
 
 OGRE_MUTEX (mListenerListMutex)
 
 OGRE_STATIC_MUTEX (msDeviceAccessMutex)
 
void postLoadImpl ()
 overridden from Resource More...
 
virtual void postUnloadImpl (void)
 Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. More...
 
virtual void preLoadImpl (void)
 Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. More...
 
void prepareImpl ()
 overridden from Resource More...
 
virtual void preUnloadImpl (void)
 Internal hook to perform actions before the unload process. More...
 
void unloadImpl (void)
 Default implementation of unload which calls freeInternalResources. More...
 
void unprepareImpl ()
 overridden from Resource More...
 

Protected Attributes

ResourceManagermCreator
 Creator. More...
 
String mCubeFaceNames [6]
 cube texture individual face names More...
 
D3DPOOL mD3DPool
 The memory pool being used. More...
 
uint32 mDepth
 
unsigned short mDesiredFloatBitDepth
 
PixelFormat mDesiredFormat
 
unsigned short mDesiredIntegerBitDepth
 
bool mDynamicTextures
 
PixelFormat mFormat
 
uint mFSAA
 
String mFSAAHint
 
DWORD mFSAAQuality
 
D3DMULTISAMPLE_TYPE mFSAAType
 
float mGamma
 
String mGroup
 The name of the resource group. More...
 
ResourceHandle mHandle
 Numeric handle for more efficient look up than name. More...
 
uint32 mHeight
 
bool mHwGamma
 
bool mHwGammaReadSupported
 Is hardware gamma supported (read)? More...
 
bool mHwGammaWriteSupported
 Is hardware gamma supported (write)? More...
 
bool mInternalResourcesCreated
 
volatile bool mIsBackgroundLoaded
 Is this resource going to be background loaded? Only applicable for multithreaded. More...
 
bool mIsManual
 Is this file manually loaded? More...
 
ListenerList mListenerList
 
LoadedStreams mLoadedStreams
 Vector of pointers to streams that were pulled from disk by prepareImpl but have yet to be pushed into texture memory by loadImpl. More...
 
ManualResourceLoadermLoader
 Optional manual loader; if provided, data is loaded from here instead of a file. More...
 
AtomicScalar< LoadingStatemLoadingState
 Is the resource currently loaded? More...
 
DeviceToTextureResourcesMap mMapDeviceToTextureResources
 Map between device to texture resources. More...
 
bool mMipmapsHardwareGenerated
 
String mName
 Unique name of the resource. More...
 
uint8 mNumMipmaps
 
uint8 mNumRequestedMipmaps
 
String mOrigin
 Origin of this resource (e.g. script name) - optional. More...
 
size_t mSize
 The size of the resource in bytes. More...
 
uint32 mSrcDepth
 
PixelFormat mSrcFormat
 Bit field, so this can't be TextureUsage. More...
 
uint32 mSrcHeight
 
uint32 mSrcWidth
 
size_t mStateCount
 State count, the number of times this resource has changed state. More...
 
SurfaceList mSurfaceList
 
TextureType mTextureType
 
bool mTreatLuminanceAsAlpha
 
int mUsage
 
uint32 mWidth
 

Friends

class D3D9HardwarePixelBuffer
 

Detailed Description

Definition at line 40 of file OgreD3D9Texture.h.

Member Typedef Documentation

typedef DeviceToTextureResourcesMap::iterator Ogre::D3D9Texture::DeviceToTextureResourcesIterator
protected

Definition at line 59 of file OgreD3D9Texture.h.

typedef map<IDirect3DDevice9*, TextureResources*>::type Ogre::D3D9Texture::DeviceToTextureResourcesMap
protected

Definition at line 58 of file OgreD3D9Texture.h.

typedef set<Listener*>::type Ogre::Resource::ListenerList
protectedinherited

Definition at line 166 of file OgreResource.h.

Definition at line 83 of file OgreD3D9Texture.h.

Vector of pointers to subsurfaces.

Definition at line 66 of file OgreD3D9Texture.h.

Member Enumeration Documentation

Enum identifying the loading state of the resource.

Enumerator
LOADSTATE_UNLOADED 

Not loaded.

LOADSTATE_LOADING 

Loading is in progress.

LOADSTATE_LOADED 

Fully loaded.

LOADSTATE_UNLOADING 

Currently unloading.

LOADSTATE_PREPARED 

Fully prepared.

LOADSTATE_PREPARING 

Preparing is in progress.

Definition at line 127 of file OgreResource.h.

Constructor & Destructor Documentation

Ogre::D3D9Texture::D3D9Texture ( ResourceManager creator,
const String name,
ResourceHandle  handle,
const String group,
bool  isManual,
ManualResourceLoader loader 
)

constructor

Ogre::D3D9Texture::~D3D9Texture ( )

destructor

Member Function Documentation

bool Ogre::D3D9Texture::_canAutoGenMipmaps ( IDirect3DDevice9 *  d3d9Device,
DWORD  srcUsage,
D3DRESOURCETYPE  srcType,
D3DFORMAT  srcFormat 
)
protected

internal method, return true if the device/texture combination can auto gen. mip maps

bool Ogre::D3D9Texture::_canUseDynamicTextures ( IDirect3DDevice9 *  d3d9Device,
DWORD  srcUsage,
D3DRESOURCETYPE  srcType,
D3DFORMAT  srcFormat 
)
protected

internal method, return true if the device/texture combination can use dynamic textures

bool Ogre::D3D9Texture::_canUseHardwareGammaCorrection ( IDirect3DDevice9 *  d3d9Device,
DWORD  srcUsage,
D3DRESOURCETYPE  srcType,
D3DFORMAT  srcFormat,
bool  forwriting 
)
protected

internal method, return true if the device/texture combination can use hardware gamma

D3DFORMAT Ogre::D3D9Texture::_chooseD3DFormat ( IDirect3DDevice9 *  d3d9Device)
protected

internal method, return a D3D pixel format for texture creation

void Ogre::D3D9Texture::_createCubeTex ( IDirect3DDevice9 *  d3d9Device)
protected

internal method, create a blank cube texture

void Ogre::D3D9Texture::_createNormTex ( IDirect3DDevice9 *  d3d9Device)
protected

internal method, create a blank normal 1D/2D texture

void Ogre::D3D9Texture::_createSurfaceList ( IDirect3DDevice9 *  d3d9Device,
TextureResources textureResources 
)
protected

internal method, create D3D9HardwarePixelBuffers for every face and mipmap level.

This method must be called after the D3D texture object was created

void Ogre::D3D9Texture::_createVolumeTex ( IDirect3DDevice9 *  d3d9Device)
protected

internal method, create a blank cube texture

virtual void Ogre::Resource::_dirtyState ( )
virtualinherited

Manually mark the state of this resource as having been changed.

Remarks
You only need to call this from outside if you explicitly want derived objects to think this object has changed.
See also
getStateCount.
virtual void Ogre::Resource::_fireLoadingComplete ( bool  wasBackgroundLoaded)
virtualinherited

Firing of loading complete event.

Remarks
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.
Parameters
wasBackgroundLoadedWhether this was a background loaded event
virtual void Ogre::Resource::_firePreparingComplete ( bool  wasBackgroundLoaded)
virtualinherited

Firing of preparing complete event.

Remarks
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.
Parameters
wasBackgroundLoadedWhether this was a background loaded event
virtual void Ogre::Resource::_fireUnloadingComplete ( void  )
virtualinherited

Firing of unloading complete event.

Remarks
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.
D3DTEXTUREFILTERTYPE Ogre::D3D9Texture::_getBestFilterMethod ( IDirect3DDevice9 *  d3d9Device)
protected

internal method, return the best by hardware supported filter method

String Ogre::D3D9Texture::_getCubeFaceName ( unsigned char  face) const
inlineprotected

internal method, the cube map face name for the spec. face index

Definition at line 136 of file OgreD3D9Texture.h.

void Ogre::D3D9Texture::_loadCubeTex ( IDirect3DDevice9 *  d3d9Device,
const LoadedStreams loadedStreams 
)
protected

internal method, load a cube texture

virtual void Ogre::Texture::_loadImages ( const ConstImagePtrList images)
virtualinherited

Internal method to load the texture from a set of images.

Note
Do NOT call this method unless you are inside the load() routine already, e.g. a ManualResourceLoader. It is not threadsafe and does not check or update resource loading status.
void Ogre::D3D9Texture::_loadNormTex ( IDirect3DDevice9 *  d3d9Device,
const LoadedStreams loadedStreams 
)
protected

internal method, load a normal texture

void Ogre::D3D9Texture::_loadVolumeTex ( IDirect3DDevice9 *  d3d9Device,
const LoadedStreams loadedStreams 
)
protected

internal method, load a volume texture

virtual void Ogre::Resource::_notifyOrigin ( const String origin)
inlinevirtualinherited

Notify this resource of it's origin.

Definition at line 420 of file OgreResource.h.

LoadedStreams Ogre::D3D9Texture::_prepareCubeTex ( )
protected

internal method, prepare a cube texture

LoadedStreams Ogre::D3D9Texture::_prepareNormTex ( )
protected

internal method, prepare a normal texture

LoadedStreams Ogre::D3D9Texture::_prepareVolumeTex ( )
protected

internal method, prepare a volume texture

void Ogre::D3D9Texture::_setFinalAttributes ( IDirect3DDevice9 *  d3d9Device,
TextureResources textureResources,
unsigned long  width,
unsigned long  height,
unsigned long  depth,
PixelFormat  format 
)
protected

internal method, set Texture class final texture protected attributes

void Ogre::D3D9Texture::_setSrcAttributes ( unsigned long  width,
unsigned long  height,
unsigned long  depth,
PixelFormat  format 
)
protected

internal method, set Texture class source image protected attributes

virtual void Ogre::Resource::addListener ( Listener lis)
virtualinherited

Register a listener on this resource.

See also
Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

TextureResources* Ogre::D3D9Texture::allocateTextureResources ( IDirect3DDevice9 *  d3d9Device)
protected

allocates new texture resources structure attached to the given device.

size_t Ogre::D3D9Texture::calculateSize ( void  ) const
protectedvirtual

Calculate the size of a resource; this will only be called after 'load'.

Reimplemented from Ogre::Texture.

virtual void Ogre::Resource::changeGroupOwnership ( const String newGroup)
virtualinherited

Change the resource group ownership of a Resource.

Remarks
This method is generally reserved for internal use, although if you really know what you're doing you can use it to move this resource from one group to another.
Parameters
newGroupName of the new group
static void Ogre::StringInterface::cleanupDictionary ( )
staticinherited

Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.

MaterialManager) initializes.

virtual void Ogre::Texture::convertToImage ( Image destImage,
bool  includeMipMaps = false 
)
virtualinherited

Populate an Image with the contents of this texture.

Parameters
destImageThe target image (contents will be overwritten)
includeMipMapsWhether to embed mipmaps in the image
virtual void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlinevirtualinherited

Method for copying this object's parameters to another object.

Remarks
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.
Any unrecognised parameters will be ignored as with setParameter method.
Parameters
destPointer to object to have it's parameters set the same as this object.

Definition at line 303 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

void Ogre::D3D9Texture::copyToTexture ( TexturePtr target)
virtual

overridden from Texture

Reimplemented from Ogre::Texture.

void Ogre::D3D9Texture::createInternalResources ( void  )
protectedvirtual

Creates the internal texture resources for this texture.

Remarks
This method creates the internal texture resources (pixel buffers, texture surfaces etc) required to begin using this texture. You do not need to call this method directly unless you are manually creating a texture, in which case something must call it, after having set the size and format of the texture (e.g. the ManualResourceLoader might be the best one to call it). If you are not defining a manual texture, or if you use one of the self-contained load...() methods, then it will be called for you.

Reimplemented from Ogre::Texture.

void Ogre::D3D9Texture::createInternalResourcesImpl ( void  )
protectedvirtual

Implementation of creating internal texture resources.

Implements Ogre::Texture.

void Ogre::D3D9Texture::createInternalResourcesImpl ( IDirect3DDevice9 *  d3d9Device)
protected

Creates this texture resources on the specified device.

bool Ogre::StringInterface::createParamDictionary ( const String className)
inlineprotectedinherited

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).
Parameters
classNamethe name of the class using the dictionary
Returns
true if a new dictionary was created, false if it was already there

Definition at line 186 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

void Ogre::D3D9Texture::createTextureResources ( IDirect3DDevice9 *  d3d9Device)
protected

creates this texture resources according to the current settings.

void Ogre::D3D9Texture::determinePool ( )
protected
virtual void Ogre::Resource::escalateLoading ( )
virtualinherited

Escalates the loading of a background loaded resource.

Remarks
If a resource is set to load in the background, but something needs it before it's been loaded, there could be a problem. If the user of this resource really can't wait, they can escalate the loading which basically pulls the loading into the current thread immediately. If the resource is already being loaded but just hasn't quite finished then this method will simply wait until the background load is complete.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::D3D9Texture::freeInternalResources ( void  )
protectedvirtual

Frees internal texture resources for this texture.

Reimplemented from Ogre::Texture.

void Ogre::D3D9Texture::freeInternalResourcesImpl ( void  )
protectedvirtual

free internal resources

Implements Ogre::Texture.

void Ogre::D3D9Texture::freeTextureResources ( IDirect3DDevice9 *  d3d9Device,
TextureResources textureResources 
)
protected

frees the given texture resources.

HardwarePixelBufferSharedPtr Ogre::D3D9Texture::getBuffer ( size_t  face,
size_t  mipmap 
)
virtual

Return hardware pixel buffer for a surface.

This buffer can then be used to copy data from and to a particular level of the texture.

Parameters
faceFace number, in case of a cubemap texture. Must be 0 for other types of textures. For cubemaps, this is one of +X (0), -X (1), +Y (2), -Y (3), +Z (4), -Z (5)
mipmapMipmap level. This goes from 0 for the first, largest mipmap level to getNumMipmaps()-1 for the smallest.
Returns
A shared pointer to a hardware pixel buffer
Remarks
The buffer is invalidated when the resource is unloaded or destroyed. Do not use it after the lifetime of the containing texture.

Implements Ogre::Texture.

virtual ResourceManager* Ogre::Resource::getCreator ( void  )
inlinevirtualinherited

Gets the manager which created this resource.

Definition at line 411 of file OgreResource.h.

IDirect3DCubeTexture9* Ogre::D3D9Texture::getCubeTexture ( )

retrieves a pointer to the cube texture

virtual void Ogre::Texture::getCustomAttribute ( const String name,
void *  pData 
)
inlinevirtualinherited

Retrieve a platform or API-specific piece of information from this texture.

This method of retrieving information should only be used if you know what you're doing.

Parameters
nameThe name of the attribute to retrieve
pDataPointer to memory matching the type of data you want to retrieve.

Reimplemented in Ogre::GLTexture, and Ogre::GL3PlusTexture.

Definition at line 384 of file OgreTexture.h.

virtual uint32 Ogre::Texture::getDepth ( void  ) const
inlinevirtualinherited

Returns the depth of the texture (only applicable for 3D textures).

Definition at line 201 of file OgreTexture.h.

virtual ushort Ogre::Texture::getDesiredFloatBitDepth ( void  ) const
virtualinherited

gets desired bit depth for float pixel format textures.

virtual PixelFormat Ogre::Texture::getDesiredFormat ( void  ) const
inlinevirtualinherited

Returns the desired pixel format for the texture surface.

Definition at line 300 of file OgreTexture.h.

virtual ushort Ogre::Texture::getDesiredIntegerBitDepth ( void  ) const
virtualinherited

gets desired bit depth for integer pixel format textures.

virtual PixelFormat Ogre::Texture::getFormat ( ) const
inlinevirtualinherited

Returns the pixel format for the texture surface.

Definition at line 294 of file OgreTexture.h.

virtual uint Ogre::Texture::getFSAA ( ) const
inlinevirtualinherited

Get the level of multisample AA to be used if this texture is a rendertarget.

Definition at line 185 of file OgreTexture.h.

virtual const String& Ogre::Texture::getFSAAHint ( ) const
inlinevirtualinherited

Get the multisample AA hint if this texture is a rendertarget.

Definition at line 189 of file OgreTexture.h.

virtual float Ogre::Texture::getGamma ( void  ) const
inlinevirtualinherited

Returns the gamma adjustment factor applied to this texture on loading.

Definition at line 136 of file OgreTexture.h.

virtual const String& Ogre::Resource::getGroup ( void  ) const
inlinevirtualinherited

Gets the group which this resource is a member of.

Definition at line 399 of file OgreResource.h.

virtual ResourceHandle Ogre::Resource::getHandle ( void  ) const
inlinevirtualinherited

Reimplemented in Ogre::SkeletonInstance.

Definition at line 317 of file OgreResource.h.

virtual uint32 Ogre::Texture::getHeight ( void  ) const
inlinevirtualinherited

Returns the height of the texture.

Definition at line 193 of file OgreTexture.h.

virtual LoadingState Ogre::Resource::getLoadingState ( ) const
inlinevirtualinherited

Returns the current loading state.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 348 of file OgreResource.h.

virtual bool Ogre::Texture::getMipmapsHardwareGenerated ( void  ) const
inlinevirtualinherited

Are mipmaps hardware generated?

Remarks
Will only be accurate after texture load, or createInternalResources

Definition at line 132 of file OgreTexture.h.

virtual const String& Ogre::Resource::getName ( void  ) const
inlinevirtualinherited

Gets resource name.

Reimplemented in Ogre::SkeletonInstance.

Definition at line 312 of file OgreResource.h.

IDirect3DTexture9* Ogre::D3D9Texture::getNormTexture ( )

retrieves a pointer to the normal 1D/2D texture

virtual size_t Ogre::Texture::getNumFaces ( ) const
virtualinherited

Return the number of faces this texture has.

This will be 6 for a cubemap texture and 1 for a 1D, 2D or 3D one.

virtual uint8 Ogre::Texture::getNumMipmaps ( void  ) const
inlinevirtualinherited

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

Definition at line 120 of file OgreTexture.h.

virtual const String& Ogre::Resource::getOrigin ( void  ) const
inlinevirtualinherited

Get the origin of this resource, e.g.

a script file name.

Remarks
This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

Definition at line 418 of file OgreResource.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  )
inlineinherited

Retrieves the parameter dictionary for this class.

Remarks
Only valid to call this after createParamDictionary.
Returns
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 219 of file OgreStringInterface.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  ) const
inlineinherited

Definition at line 224 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String name) const
inlinevirtualinherited

Generic parameter retrieval method.

Remarks
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.
Parameters
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

Definition at line 272 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

const ParameterList& Ogre::StringInterface::getParameters ( void  ) const
inherited

Retrieves a list of parameters valid for this object.

Returns
A reference to a static list of ParameterDef objects.
virtual size_t Ogre::Resource::getSize ( void  ) const
inlinevirtualinherited

Retrieves info about the size of the resource.

Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.

Definition at line 301 of file OgreResource.h.

String Ogre::Texture::getSourceFileType ( ) const
protectedinherited

Identify the source file type as a string, either from the extension or from a magic number.

virtual uint32 Ogre::Texture::getSrcDepth ( void  ) const
inlinevirtualinherited

Returns the original depth of the input texture (only applicable for 3D textures).

Definition at line 213 of file OgreTexture.h.

virtual PixelFormat Ogre::Texture::getSrcFormat ( void  ) const
inlinevirtualinherited

Returns the pixel format of the original input texture (may differ due to hardware requirements and pixel format conversion).

Definition at line 308 of file OgreTexture.h.

virtual uint32 Ogre::Texture::getSrcHeight ( void  ) const
inlinevirtualinherited

Returns the height of the original input texture (may differ due to hardware requirements).

Definition at line 205 of file OgreTexture.h.

virtual uint32 Ogre::Texture::getSrcWidth ( void  ) const
inlinevirtualinherited

Returns the width of the original input texture (may differ due to hardware requirements).

Definition at line 209 of file OgreTexture.h.

virtual size_t Ogre::Resource::getStateCount ( ) const
inlinevirtualinherited

Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.

Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback.

Definition at line 429 of file OgreResource.h.

IDirect3DBaseTexture9* Ogre::D3D9Texture::getTexture ( )

retrieves a pointer to the actual texture

TextureResources* Ogre::D3D9Texture::getTextureResources ( IDirect3DDevice9 *  d3d9Device)
protected

gets the texture resources attached to the given device.

virtual TextureType Ogre::Texture::getTextureType ( void  ) const
inlinevirtualinherited

Gets the type of texture.

Definition at line 116 of file OgreTexture.h.

virtual bool Ogre::Texture::getTreatLuminanceAsAlpha ( void  ) const
virtualinherited

Gets whether luminace pixel format will treated as alpha format when load this texture.

virtual int Ogre::Texture::getUsage ( ) const
inlinevirtualinherited

Returns the TextureUsage identifier for this Texture.

Definition at line 230 of file OgreTexture.h.

virtual uint32 Ogre::Texture::getWidth ( void  ) const
inlinevirtualinherited

Returns the width of the texture.

Definition at line 197 of file OgreTexture.h.

virtual bool Ogre::Texture::hasAlpha ( void  ) const
virtualinherited

Returns true if the texture has an alpha layer.

virtual bool Ogre::Resource::isBackgroundLoaded ( void  ) const
inlinevirtualinherited

Returns whether this Resource has been earmarked for background loading.

Remarks
This option only makes sense when you have built Ogre with thread support (OGRE_THREAD_SUPPORT). If a resource has been marked for background loading, then it won't load on demand like normal when load() is called. Instead, it will ignore request to load() except if the caller indicates it is the background loader. Any other users of this resource should check isLoaded(), and if that returns false, don't use the resource and come back later.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 365 of file OgreResource.h.

virtual bool Ogre::Texture::isHardwareGammaEnabled ( ) const
inlinevirtualinherited

Gets whether this texture will be set up so that on sampling it, hardware gamma correction is applied.

Definition at line 171 of file OgreTexture.h.

bool Ogre::D3D9Texture::isHardwareGammaReadToBeUsed ( ) const
inline

Indicates whether the hardware gamma is actually enabled and supported.

Remarks
Because hardware gamma might not actually be supported, we need to ignore it sometimes. Because D3D doesn't encode sRGB in the format but as a sampler state, and we don't want to change the original requested hardware gamma flag (e.g. serialisation) we need another indicator.

Definition at line 203 of file OgreD3D9Texture.h.

virtual bool Ogre::Resource::isLoaded ( void  ) const
inlinevirtualinherited

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 332 of file OgreResource.h.

virtual bool Ogre::Resource::isLoading ( ) const
inlinevirtualinherited

Returns whether the resource is currently in the process of background loading.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 341 of file OgreResource.h.

virtual bool Ogre::Resource::isManuallyLoaded ( void  ) const
inlinevirtualinherited

Is this resource manually loaded?

Definition at line 289 of file OgreResource.h.

virtual bool Ogre::Resource::isPrepared ( void  ) const
inlinevirtualinherited

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

Definition at line 324 of file OgreResource.h.

virtual bool Ogre::Resource::isReloadable ( void  ) const
inlinevirtualinherited

Returns true if the Resource is reloadable, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 282 of file OgreResource.h.

virtual void Ogre::Resource::load ( bool  backgroundThread = false)
virtualinherited

Loads the resource, if it is not already.

Remarks
If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own.
Parameters
backgroundThreadIndicates whether the caller of this method is the background resource loading thread.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::Texture::loadImage ( const Image img)
virtualinherited

Loads the data from an image.

Note
Important: only call this from outside the load() routine of a Resource. Don't call it within (including ManualResourceLoader) - use _loadImages() instead. This method is designed to be external, performs locking and checks the load status before loading.

Reimplemented in Ogre::D3D11Texture.

void Ogre::D3D9Texture::loadImpl ( )
protectedvirtual

overridden from Resource

Implements Ogre::Resource.

void Ogre::D3D9Texture::loadImpl ( IDirect3DDevice9 *  d3d9Device)
protected

Loads this texture into the specified device.

virtual void Ogre::Texture::loadRawData ( DataStreamPtr stream,
ushort  uWidth,
ushort  uHeight,
PixelFormat  eFormat 
)
virtualinherited

Loads the data from a raw stream.

Note
Important: only call this from outside the load() routine of a Resource. Don't call it within (including ManualResourceLoader) - use _loadImages() instead. This method is designed to be external, performs locking and checks the load status before loading.
Parameters
streamData stream containing the raw pixel data
uWidthWidth of the image
uHeightHeight of the image
eFormatThe format of the pixel data
static void Ogre::D3D9Resource::lockDeviceAccess ( )
staticinherited
virtual void Ogre::D3D9Texture::notifyOnDeviceCreate ( IDirect3DDevice9 *  d3d9Device)
virtual

Reimplemented from Ogre::D3D9Resource.

virtual void Ogre::D3D9Texture::notifyOnDeviceDestroy ( IDirect3DDevice9 *  d3d9Device)
virtual

Reimplemented from Ogre::D3D9Resource.

virtual void Ogre::D3D9Texture::notifyOnDeviceLost ( IDirect3DDevice9 *  d3d9Device)
virtual

Reimplemented from Ogre::D3D9Resource.

virtual void Ogre::D3D9Texture::notifyOnDeviceReset ( IDirect3DDevice9 *  d3d9Device)
virtual

Reimplemented from Ogre::D3D9Resource.

Ogre::Resource::OGRE_MUTEX ( mListenerListMutex  )
protectedinherited
Ogre::D3D9Resource::OGRE_STATIC_MUTEX ( msDeviceAccessMutex  )
protectedinherited
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::D3D9Texture::postLoadImpl ( )
protectedvirtual

overridden from Resource

Reimplemented from Ogre::Resource.

virtual void Ogre::Resource::postUnloadImpl ( void  )
inlineprotectedvirtualinherited

Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.

Note
Mutex will have already been acquired by the unloading thread.

Definition at line 201 of file OgreResource.h.

virtual void Ogre::Resource::preLoadImpl ( void  )
inlineprotectedvirtualinherited

Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.

Note
Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Definition at line 184 of file OgreResource.h.

virtual void Ogre::Resource::prepare ( bool  backgroundThread = false)
virtualinherited

Prepares the resource for load, if it is not already.

One can call prepare() before load(), but this is not required as load() will call prepare() itself, if needed. When OGRE_THREAD_SUPPORT==1 both load() and prepare() are thread-safe. When OGRE_THREAD_SUPPORT==2 however, only prepare() is thread-safe. The reason for this function is to allow a background thread to do some of the loading work, without requiring the whole render system to be thread-safe. The background thread would call prepare() while the main render loop would later call load(). So long as prepare() remains thread-safe, subclasses can arbitrarily split the work of loading a resource between load() and prepare(). It is best to try and do as much work in prepare(), however, since this will leave less work for the main render thread to do and thus increase FPS.

Parameters
backgroundThreadWhether this is occurring in a background thread
void Ogre::D3D9Texture::prepareImpl ( )
protectedvirtual

overridden from Resource

Reimplemented from Ogre::Resource.

virtual void Ogre::Resource::preUnloadImpl ( void  )
inlineprotectedvirtualinherited

Internal hook to perform actions before the unload process.

Note
Mutex will have already been acquired by the unloading thread.

Definition at line 196 of file OgreResource.h.

virtual void Ogre::Resource::reload ( void  )
virtualinherited

Reloads the resource, if it is already loaded.

Remarks
Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::Resource::removeListener ( Listener lis)
virtualinherited

Remove a listener on this resource.

See also
Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::Resource::setBackgroundLoaded ( bool  bl)
inlinevirtualinherited

Tells the resource whether it is background loaded or not.

See also
Resource::isBackgroundLoaded. Note that calling this only defers the normal on-demand loading behaviour of a resource, it does not actually set up a thread to make sure the resource gets loaded in the background. You should use ResourceBackgroundLoadingQueue to manage the actual loading (which will call this method itself).

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 375 of file OgreResource.h.

virtual void Ogre::Texture::setDepth ( uint32  d)
inlinevirtualinherited

Set the depth of the texture (only applicable for 3D textures); can only do this before load();.

Definition at line 226 of file OgreTexture.h.

virtual void Ogre::Texture::setDesiredBitDepths ( ushort  integerBits,
ushort  floatBits 
)
virtualinherited

Sets desired bit depth for integer and float pixel format.

virtual void Ogre::Texture::setDesiredFloatBitDepth ( ushort  bits)
virtualinherited

Sets desired bit depth for float pixel format textures.

Note
Available values: 0, 16 and 32, where 0 (the default) means keep original format as it is. This value is number of bits for a channel of the pixel.
virtual void Ogre::Texture::setDesiredIntegerBitDepth ( ushort  bits)
virtualinherited

Sets desired bit depth for integer pixel format textures.

Note
Available values: 0, 16 and 32, where 0 (the default) means keep original format as it is. This value is number of bits for the pixel.
virtual void Ogre::Texture::setFormat ( PixelFormat  pf)
virtualinherited

Sets the pixel format for the texture surface; can only be set before load().

virtual void Ogre::Texture::setFSAA ( uint  fsaa,
const String fsaaHint 
)
inlinevirtualinherited

Set the level of multisample AA to be used if this texture is a rendertarget.

Note
This option will be ignored if TU_RENDERTARGET is not part of the usage options on this texture, or if the hardware does not support it.
Parameters
fsaaThe number of samples
fsaaHintAny hinting text (
See also
Root::createRenderWindow)

Definition at line 180 of file OgreTexture.h.

virtual void Ogre::Texture::setGamma ( float  g)
inlinevirtualinherited

Sets the gamma adjustment factor applied to this texture on loading the data.

Note
Must be called before any 'load' method. This gamma factor will be premultiplied in and may reduce the precision of your textures. You can use setHardwareGamma if supported to apply gamma on sampling the texture instead.

Definition at line 146 of file OgreTexture.h.

virtual void Ogre::Texture::setHardwareGammaEnabled ( bool  enabled)
inlinevirtualinherited

Sets whether this texture will be set up so that on sampling it, hardware gamma correction is applied.

Remarks
24-bit textures are often saved in gamma colour space; this preserves precision in the 'darks'. However, if you're performing blending on the sampled colours, you really want to be doing it in linear space. One way is to apply a gamma correction value on loading (see setGamma), but this means you lose precision in those dark colours. An alternative is to get the hardware to do the gamma correction when reading the texture and converting it to a floating point value for the rest of the pipeline. This option allows you to do that; it's only supported in relatively recent hardware (others will ignore it) but can improve the quality of colour reproduction.
Note
Must be called before any 'load' method since it may affect the construction of the underlying hardware resources. Also note this only useful on textures using 8-bit colour channels.

Definition at line 166 of file OgreTexture.h.

virtual void Ogre::Texture::setHeight ( uint32  h)
inlinevirtualinherited

Set the height of the texture; can only do this before load();.

Definition at line 217 of file OgreTexture.h.

virtual void Ogre::Texture::setNumMipmaps ( uint8  num)
inlinevirtualinherited

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

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

Definition at line 126 of file OgreTexture.h.

virtual bool Ogre::StringInterface::setParameter ( const String name,
const String value 
)
virtualinherited

Generic parameter setting method.

Remarks
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
nameThe name of the parameter to set
valueString value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.
Returns
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList paramList)
virtualinherited

Generic multiple parameter setting method.

Remarks
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
paramListName/value pair list
virtual void Ogre::Texture::setTextureType ( TextureType  ttype)
inlinevirtualinherited

Sets the type of texture; can only be changed before load()

Definition at line 112 of file OgreTexture.h.

virtual void Ogre::Texture::setTreatLuminanceAsAlpha ( bool  asAlpha)
virtualinherited

Sets whether luminace pixel format will treated as alpha format when load this texture.

virtual void Ogre::Texture::setUsage ( int  u)
inlinevirtualinherited

Sets the TextureUsage identifier for this Texture; only useful before load()

Parameters
uis a combination of TU_STATIC, TU_DYNAMIC, TU_WRITE_ONLY TU_AUTOMIPMAP and TU_RENDERTARGET (see TextureUsage enum). You are strongly advised to use HBU_STATIC_WRITE_ONLY wherever possible, if you need to update regularly, consider HBU_DYNAMIC_WRITE_ONLY.

Definition at line 242 of file OgreTexture.h.

virtual void Ogre::Texture::setWidth ( uint32  w)
inlinevirtualinherited

Set the width of the texture; can only do this before load();.

Definition at line 221 of file OgreTexture.h.

virtual void Ogre::Resource::touch ( void  )
virtualinherited

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

Reimplemented in Ogre::Material, Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.

Referenced by Ogre::Material::touch().

virtual void Ogre::Resource::unload ( void  )
virtualinherited

Unloads the resource; this is not permanent, the resource can be reloaded later if required.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::Texture::unloadImpl ( void  )
protectedvirtualinherited

Default implementation of unload which calls freeInternalResources.

Implements Ogre::Resource.

static void Ogre::D3D9Resource::unlockDeviceAccess ( )
staticinherited
void Ogre::D3D9Texture::unprepareImpl ( )
protectedvirtual

overridden from Resource

Reimplemented from Ogre::Resource.

bool Ogre::D3D9Texture::useDefaultPool ( )

Will this texture need to be in the default pool?

Friends And Related Function Documentation

friend class D3D9HardwarePixelBuffer
friend

Definition at line 174 of file OgreD3D9Texture.h.

Member Data Documentation

ResourceManager* Ogre::Resource::mCreator
protectedinherited

Creator.

Definition at line 144 of file OgreResource.h.

String Ogre::D3D9Texture::mCubeFaceNames[6]
protected

cube texture individual face names

Definition at line 69 of file OgreD3D9Texture.h.

D3DPOOL Ogre::D3D9Texture::mD3DPool
protected

The memory pool being used.

Definition at line 71 of file OgreD3D9Texture.h.

uint32 Ogre::Texture::mDepth
protectedinherited

Definition at line 391 of file OgreTexture.h.

unsigned short Ogre::Texture::mDesiredFloatBitDepth
protectedinherited

Definition at line 410 of file OgreTexture.h.

PixelFormat Ogre::Texture::mDesiredFormat
protectedinherited

Definition at line 408 of file OgreTexture.h.

unsigned short Ogre::Texture::mDesiredIntegerBitDepth
protectedinherited

Definition at line 409 of file OgreTexture.h.

bool Ogre::D3D9Texture::mDynamicTextures
protected

Definition at line 73 of file OgreD3D9Texture.h.

PixelFormat Ogre::Texture::mFormat
protectedinherited

Definition at line 402 of file OgreTexture.h.

uint Ogre::Texture::mFSAA
protectedinherited

Definition at line 398 of file OgreTexture.h.

String Ogre::Texture::mFSAAHint
protectedinherited

Definition at line 399 of file OgreTexture.h.

DWORD Ogre::D3D9Texture::mFSAAQuality
protected

Definition at line 80 of file OgreD3D9Texture.h.

D3DMULTISAMPLE_TYPE Ogre::D3D9Texture::mFSAAType
protected

Definition at line 79 of file OgreD3D9Texture.h.

float Ogre::Texture::mGamma
protectedinherited

Definition at line 396 of file OgreTexture.h.

String Ogre::Resource::mGroup
protectedinherited

The name of the resource group.

Definition at line 148 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle
protectedinherited

Numeric handle for more efficient look up than name.

Definition at line 150 of file OgreResource.h.

uint32 Ogre::Texture::mHeight
protectedinherited

Definition at line 389 of file OgreTexture.h.

bool Ogre::Texture::mHwGamma
protectedinherited

Definition at line 397 of file OgreTexture.h.

bool Ogre::D3D9Texture::mHwGammaReadSupported
protected

Is hardware gamma supported (read)?

Definition at line 76 of file OgreD3D9Texture.h.

bool Ogre::D3D9Texture::mHwGammaWriteSupported
protected

Is hardware gamma supported (write)?

Definition at line 78 of file OgreD3D9Texture.h.

bool Ogre::Texture::mInternalResourcesCreated
protectedinherited

Definition at line 413 of file OgreTexture.h.

volatile bool Ogre::Resource::mIsBackgroundLoaded
protectedinherited

Is this resource going to be background loaded? Only applicable for multithreaded.

Definition at line 154 of file OgreResource.h.

bool Ogre::Resource::mIsManual
protectedinherited

Is this file manually loaded?

Definition at line 158 of file OgreResource.h.

ListenerList Ogre::Resource::mListenerList
protectedinherited

Definition at line 167 of file OgreResource.h.

LoadedStreams Ogre::D3D9Texture::mLoadedStreams
protected

Vector of pointers to streams that were pulled from disk by prepareImpl but have yet to be pushed into texture memory by loadImpl.

Should be cleared on load and on unprepare.

Definition at line 172 of file OgreD3D9Texture.h.

ManualResourceLoader* Ogre::Resource::mLoader
protectedinherited

Optional manual loader; if provided, data is loaded from here instead of a file.

Definition at line 162 of file OgreResource.h.

AtomicScalar<LoadingState> Ogre::Resource::mLoadingState
protectedinherited

Is the resource currently loaded?

Definition at line 152 of file OgreResource.h.

DeviceToTextureResourcesMap Ogre::D3D9Texture::mMapDeviceToTextureResources
protected

Map between device to texture resources.

Definition at line 62 of file OgreD3D9Texture.h.

bool Ogre::Texture::mMipmapsHardwareGenerated
protectedinherited

Definition at line 395 of file OgreTexture.h.

String Ogre::Resource::mName
protectedinherited

Unique name of the resource.

Definition at line 146 of file OgreResource.h.

uint8 Ogre::Texture::mNumMipmaps
protectedinherited

Definition at line 394 of file OgreTexture.h.

uint8 Ogre::Texture::mNumRequestedMipmaps
protectedinherited

Definition at line 393 of file OgreTexture.h.

String Ogre::Resource::mOrigin
protectedinherited

Origin of this resource (e.g. script name) - optional.

Definition at line 160 of file OgreResource.h.

size_t Ogre::Resource::mSize
protectedinherited

The size of the resource in bytes.

Definition at line 156 of file OgreResource.h.

uint32 Ogre::Texture::mSrcDepth
protectedinherited

Definition at line 406 of file OgreTexture.h.

PixelFormat Ogre::Texture::mSrcFormat
protectedinherited

Bit field, so this can't be TextureUsage.

Definition at line 405 of file OgreTexture.h.

uint32 Ogre::Texture::mSrcHeight
protectedinherited

Definition at line 406 of file OgreTexture.h.

uint32 Ogre::Texture::mSrcWidth
protectedinherited

Definition at line 406 of file OgreTexture.h.

size_t Ogre::Resource::mStateCount
protectedinherited

State count, the number of times this resource has changed state.

Definition at line 164 of file OgreResource.h.

SurfaceList Ogre::D3D9Texture::mSurfaceList
protected

Definition at line 67 of file OgreD3D9Texture.h.

TextureType Ogre::Texture::mTextureType
protectedinherited

Definition at line 401 of file OgreTexture.h.

bool Ogre::Texture::mTreatLuminanceAsAlpha
protectedinherited

Definition at line 411 of file OgreTexture.h.

int Ogre::Texture::mUsage
protectedinherited

Definition at line 403 of file OgreTexture.h.

uint32 Ogre::Texture::mWidth
protectedinherited

Definition at line 390 of file OgreTexture.h.

Ogre::Resource::OGRE_AUTO_MUTEX
inherited

Definition at line 82 of file OgreResource.h.


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