![]() |
OGRE 2.1
Object-Oriented Graphics Rendering Engine
|
#include <OgreGL3PlusNullTexture.h>
Public Types | |
enum | LoadingFlags { LF_DEFAULT = 0 , LF_INCLUDE_NON_RELOADABLE = 1 , LF_ONLY_UNREFERENCED = 2 , LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3 , LF_PRESERVE_STATE = 4 } |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More... | |
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 | |
GL3PlusNullTexture (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, GL3PlusSupport &support) | |
virtual | ~GL3PlusNullTexture () |
virtual void | _dirtyState () |
Manually mark the state of this resource as having been changed. | |
virtual void | _fireLoadingComplete (bool wasBackgroundLoaded) |
Firing of loading complete event. | |
virtual void | _firePreparingComplete (bool wasBackgroundLoaded) |
Firing of preparing complete event. | |
virtual void | _fireUnloadingComplete (void) |
Firing of unloading complete event. | |
virtual void | _loadImages (const ConstImagePtrList &images) |
Internal method to load the texture from a set of images. | |
virtual void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. | |
virtual void | addListener (Listener *lis) |
Register a listener on this resource. | |
virtual void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. | |
virtual void | convertToImage (Image &destImage, bool includeMipMaps=false, uint32 mipmapBias=0, uint32 zOrSliceStart=0, uint32 depthOrSlices=0) |
Populate an Image with the contents of this texture. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
virtual void | copyToTexture (TexturePtr &target) |
Copies (and maybe scales to fit) the contents of this texture to another texture. | |
virtual void | createInternalResources (void) |
Creates the internal texture resources for this texture. | |
void | createRenderTexture () |
virtual void | escalateLoading () |
Escalates the loading of a background loaded resource. | |
virtual void | freeInternalResources (void) |
Frees internal texture resources for this texture. | |
v1::HardwarePixelBufferSharedPtr | getBuffer (size_t face, size_t mipmap) |
Return hardware pixel buffer for a surface. | |
virtual ResourceManager * | getCreator (void) |
Gets the manager which created this resource. | |
virtual void | getCustomAttribute (const String &name, void *pData) |
Retrieve a platform or API-specific piece of information from this texture. | |
uint32 | getDepth (void) const |
Returns the depth of the texture (only applicable for 3D textures). | |
virtual ushort | getDesiredFloatBitDepth (void) const |
gets desired bit depth for float pixel format textures. | |
PixelFormat | getDesiredFormat (void) const |
Returns the desired pixel format for the texture surface. | |
virtual ushort | getDesiredIntegerBitDepth (void) const |
gets desired bit depth for integer pixel format textures. | |
PixelFormat | getFormat () const |
Returns the pixel format for the texture surface. | |
virtual uint | getFSAA () const |
Get the level of multisample AA to be used if this texture is a rendertarget. | |
virtual const String & | getFSAAHint () const |
Get the multisample AA hint if this texture is a rendertarget. | |
float | getGamma (void) const |
Returns the gamma adjustment factor applied to this texture on loading. | |
GLenum | getGL3PlusTextureTarget (void) const |
GLuint | getGLID (bool &outIsFsaa) |
Returns the GL Id of the texture. | |
virtual const String & | getGroup (void) const |
Gets the group which this resource is a member of. | |
virtual ResourceHandle | getHandle (void) const |
uint32 | getHeight (void) const |
Returns the height of the texture. | |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. | |
bool | getMipmapsHardwareGenerated (void) const |
Are mipmaps hardware generated? | |
virtual const String & | getName (void) const |
Gets resource name. | |
virtual size_t | getNumFaces () const |
Return the number of faces this texture has. | |
uint8 | getNumMipmaps (void) const |
Gets the number of mipmaps to be used for this texture. | |
virtual const String & | getOrigin (void) const |
Get the origin of this resource, e.g. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual size_t | getSize (void) const |
Retrieves info about the size of the resource. | |
uint32 | getSrcDepth (void) const |
Returns the original depth of the input texture (only applicable for 3D textures). | |
PixelFormat | getSrcFormat (void) const |
Returns the pixel format of the original input texture (may differ due to hardware requirements and pixel format conversion). | |
uint32 | getSrcHeight (void) const |
Returns the height of the original input texture (may differ due to hardware requirements). | |
uint32 | getSrcWidth (void) const |
Returns the width of the original input texture (may differ due to hardware requirements). | |
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. | |
TextureType | getTextureType (void) const |
Gets the type of texture. | |
virtual bool | getTreatLuminanceAsAlpha (void) const |
Gets whether luminace pixel format will treated as alpha format when load this texture. | |
virtual int | getUsage () const |
Returns the TextureUsage identifier for this Texture. | |
uint32 | getWidth (void) const |
Returns the width of the texture. | |
virtual bool | hasAlpha (void) const |
Returns true if the texture has an alpha layer. | |
virtual bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. | |
virtual bool | isHardwareGammaEnabled () const |
Gets whether this texture will be set up so that on sampling it, hardware gamma correction is applied. | |
virtual bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. | |
virtual bool | isLoading () const |
Returns whether the resource is currently in the process of background loading. | |
virtual bool | isManuallyLoaded (void) const |
Is this resource manually loaded? | |
virtual bool | isPrepared (void) const |
Returns true if the Resource has been prepared, false otherwise. | |
virtual bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. | |
bool | isTextureTypeArray (void) const |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. | |
virtual void | loadImage (const Image &img) |
Loads the data from an image. | |
virtual void | loadRawData (DataStreamPtr &stream, ushort uWidth, ushort uHeight, PixelFormat eFormat) |
Loads the data from a raw stream. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info | |
void * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
virtual void | prepare (bool backgroundThread=false) |
Prepares the resource for load, if it is not already. | |
virtual void | reload (LoadingFlags flags=LF_DEFAULT) |
Reloads the resource, if it is already loaded. | |
virtual void | removeListener (Listener *lis) |
Remove a listener on this resource. | |
virtual void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. | |
void | setDepth (uint32 d) |
Set the depth of the texture (only applicable for 3D textures); can only do this before load();. | |
virtual void | setDesiredBitDepths (ushort integerBits, ushort floatBits) |
Sets desired bit depth for integer and float pixel format. | |
virtual void | setDesiredFloatBitDepth (ushort bits) |
Sets desired bit depth for float pixel format textures. | |
virtual void | setDesiredIntegerBitDepth (ushort bits) |
Sets desired bit depth for integer pixel format textures. | |
virtual void | setFormat (PixelFormat pf) |
Sets the pixel format for the texture surface; can only be set before load(). | |
virtual void | setFSAA (uint fsaa, const String &fsaaHint, bool explicitResolve) |
Set the level of multisample AA to be used if this texture is a rendertarget. | |
void | setGamma (float g) |
Sets the gamma adjustment factor applied to this texture on loading the data. | |
void | setHardwareGammaEnabled (bool enabled) |
Sets whether this texture will be set up so that on sampling it, hardware gamma correction is applied. | |
void | setHeight (uint32 h) |
Set the height of the texture; can only do this before load();. | |
virtual void | setManuallyLoaded (bool isManual) |
Set "Is this resource manually loaded?". | |
void | setNumMipmaps (uint8 num) |
Sets the number of mipmaps to be used for this texture. | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
void | setTextureType (TextureType ttype) |
Sets the type of texture; can only be changed before load() | |
virtual void | setToLoaded (void) |
Change the Resource loading state to loaded. | |
virtual void | setTreatLuminanceAsAlpha (bool asAlpha) |
Sets whether luminace pixel format will treated as alpha format when load this texture. | |
virtual void | setUsage (int u) |
Sets the TextureUsage identifier for this Texture; only useful before load() | |
void | setWidth (uint32 w) |
Set the width of the texture; can only do this before load();. | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. | |
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. | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
|
inherited |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior.
|
inherited |
Ogre::GL3PlusNullTexture::GL3PlusNullTexture | ( | ResourceManager * | creator, |
const String & | name, | ||
ResourceHandle | handle, | ||
const String & | group, | ||
bool | isManual, | ||
ManualResourceLoader * | loader, | ||
GL3PlusSupport & | support | ||
) |
|
virtual |
Manually mark the state of this resource as having been changed.
Firing of loading complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
Firing of preparing complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
Firing of unloading complete event.
|
virtualinherited |
Internal method to load the texture from a set of images.
Notify this resource of it's origin.
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
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.
|
virtualinherited |
Populate an Image with the contents of this texture.
destImage | The target image (contents will be overwritten) |
includeMipMaps | Whether to embed mipmaps in the image |
mipmapBias | From which mipmap we should start from; in range [0; getNumMipmaps()] |
zOrSliceStart | First slice to use. Only valid for 2D Array, 3D and Cubemap textures |
depthOrSlices | Number of slices to export. Only valid for 2D Array, 3D and Cubemap textures. A value of 0 means all of them starting from firstSlice. |
|
inlinevirtualinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
|
virtualinherited |
Copies (and maybe scales to fit) the contents of this texture to another texture.
Reimplemented in Ogre::D3D11Texture, and Ogre::D3D9Texture.
Creates the internal texture resources for this texture.
Reimplemented in Ogre::D3D11DepthTexture, Ogre::D3D11NullTexture, and Ogre::MetalNullTexture.
|
inherited |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Frees internal texture resources for this texture.
Reimplemented in Ogre::D3D11DepthTexture, Ogre::D3D11NullTexture, and Ogre::MetalNullTexture.
|
virtualinherited |
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.
face | Face 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) |
mipmap | Mipmap level. This goes from 0 for the first, largest mipmap level to getNumMipmaps()-1 for the smallest. |
Implements Ogre::Texture.
|
inlinevirtualinherited |
Gets the manager which created this resource.
|
virtualinherited |
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.
name | The name of the attribute to retrieve |
pData | Pointer to memory matching the type of data you want to retrieve. |
Reimplemented from Ogre::Texture.
Returns the depth of the texture (only applicable for 3D textures).
gets desired bit depth for float pixel format textures.
|
inlineinherited |
Returns the desired pixel format for the texture surface.
gets desired bit depth for integer pixel format textures.
|
inlineinherited |
Returns the pixel format for the texture surface.
Get the level of multisample AA to be used if this texture is a rendertarget.
Get the multisample AA hint if this texture is a rendertarget.
Returns the gamma adjustment factor applied to this texture on loading.
Returns the GL Id of the texture.
When this texture is a render target with FSAA enabled and explicit resolves, it may return the ID of the Multisample texture version instead. When this happens, outIsFsaa will be set to true.
outIsFsaa | True if the returned value belongs to a 2D multisample buffer. This will happen if all of the following conditions are met: Texture is a RenderTarget that uses antialising Explicit resolves are turned on The texture hasn't been resolved yet. |
References Ogre::TU_AUTOMIPMAP, Ogre::TU_AUTOMIPMAP_AUTO, and Ogre::TU_RENDERTARGET.
Gets the group which this resource is a member of.
Reimplemented in Ogre::v1::OldSkeletonInstance.
|
inlinevirtualinherited |
Reimplemented in Ogre::v1::OldSkeletonInstance.
|
inlinevirtualinherited |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Are mipmaps hardware generated?
Gets resource name.
Reimplemented in Ogre::v1::OldSkeletonInstance.
Referenced by Ogre::GpuProgramUsage::getProgramName().
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.
Gets the number of mipmaps to be used for this texture.
Get the origin of this resource, e.g.
a script file name.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
|
inlineinherited |
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
|
inherited |
Retrieves a list of parameters valid for this object.
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram, and Ogre::CgProgram.
Returns the original depth of the input texture (only applicable for 3D textures).
|
inlineinherited |
Returns the pixel format of the original input texture (may differ due to hardware requirements and pixel format conversion).
Returns the height of the original input texture (may differ due to hardware requirements).
Returns the width of the original input texture (may differ due to hardware requirements).
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.
|
inlineinherited |
Gets the type of texture.
Gets whether luminace pixel format will treated as alpha format when load this texture.
Returns the TextureUsage identifier for this Texture.
Returns true if the texture has an alpha layer.
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Gets whether this texture will be set up so that on sampling it, hardware gamma correction is applied.
Referenced by Ogre::NULLTexture::getBuffer().
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Is this resource manually loaded?
Returns true if the Resource has been prepared, false otherwise.
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
References Ogre::TEX_TYPE_2D_ARRAY.
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Loads the data from an image.
Reimplemented in Ogre::D3D11DepthTexture, Ogre::D3D11NullTexture, Ogre::D3D11Texture, and Ogre::MetalNullTexture.
|
virtualinherited |
Loads the data from a raw stream.
stream | Data stream containing the raw pixel data |
uWidth | Width of the image |
uHeight | Height of the image |
eFormat | The format of the pixel data |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
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.
backgroundThread | Whether this is occurring in a background thread |
|
virtualinherited |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::v1::Mesh, and Ogre::UnifiedHighLevelGpuProgram.
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Set the depth of the texture (only applicable for 3D textures); can only do this before load();.
|
virtualinherited |
Sets desired bit depth for integer and float pixel format.
Sets desired bit depth for float pixel format textures.
Sets desired bit depth for integer pixel format textures.
|
virtualinherited |
Sets the pixel format for the texture surface; can only be set before load().
|
inlinevirtualinherited |
Set the level of multisample AA to be used if this texture is a rendertarget.
fsaa | The number of samples |
fsaaHint | Any hinting text ( |
explicitResolve | @See TextureDefinitionBase::TextureDefinition::fsaaExplicitResolve |
Sets the gamma adjustment factor applied to this texture on loading the data.
Sets whether this texture will be set up so that on sampling it, hardware gamma correction is applied.
Set the height of the texture; can only do this before load();.
Set "Is this resource manually loaded?".
Sets the number of mipmaps to be used for this texture.
|
virtualinherited |
Generic parameter setting method.
name | The name of the parameter to set |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
|
inlineinherited |
Sets the type of texture; can only be changed before load()
Change the Resource loading state to loaded.
Sets whether luminace pixel format will treated as alpha format when load this texture.
Sets the TextureUsage identifier for this Texture; only useful before load()
u | is 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. |
Set the width of the texture; can only do this before load();.
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, Ogre::UnifiedHighLevelGpuProgram, and Ogre::CgProgram.
Referenced by Ogre::Material::touch().
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inherited |