Urho3D::TextureCube Class Reference
Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Private Member Functions |
Private Attributes |
List of all members
Urho3D::TextureCube Class Reference
Cube texture resource. More...
#include <Urho3D/Graphics/TextureCube.h>
Inheritance diagram for Urho3D::TextureCube:
Collaboration diagram for Urho3D::TextureCube:
Public Member Functions | |
| TextureCube (Context *context) | |
| Construct. | |
| ~TextureCube () override | |
| Destruct. | |
| bool | BeginLoad (Deserializer &source) override |
| Load resource from stream. May be called from a worker thread. Return true if successful. | |
| bool | EndLoad () override |
| Finish resource loading. Always called from the main thread. Return true if successful. | |
| void | OnDeviceLost () override |
| Mark the GPU resource destroyed on context destruction. | |
| void | OnDeviceReset () override |
| Recreate the GPU resource and restore data if applicable. | |
| void | Release () override |
| Release the texture. | |
| bool | SetSize (int size, unsigned format, TextureUsage usage=TEXTURE_STATIC, int multiSample=1) |
| Set size, format, usage and multisampling parameter for rendertargets. Note that cube textures always use autoresolve when multisampled due to lacking support (on all APIs) to multisample them in a shader. Return true if successful. | |
| bool | SetData (CubeMapFace face, unsigned level, int x, int y, int width, int height, const void *data) |
| Set data either partially or fully on a face's mip level. Return true if successful. | |
| bool | SetData (CubeMapFace face, Deserializer &source) |
| Set data of one face from a stream. Return true if successful. | |
| bool | SetData (CubeMapFace face, Image *image, bool useAlpha=false) |
| Set data of one face from an image. Return true if successful. Optionally make a single channel image alpha-only. | |
| bool | GetData (CubeMapFace face, unsigned level, void *dest) const |
| Get data from a face's mip level. The destination buffer must be big enough. Return true if successful. | |
| SharedPtr< Image > | GetImage (CubeMapFace face) const |
| Get image data from a face's zero mip level. Only RGB and RGBA textures are supported. | |
| RenderSurface * | GetRenderSurface (CubeMapFace face) const |
 Public Member Functions inherited from Urho3D::Texture | |
| Texture (Context *context) | |
| Construct. | |
| ~Texture () override | |
| Destruct. | |
| void | SetNumLevels (unsigned levels) |
| Set number of requested mip levels. Needs to be called before setting size. More... | |
| void | SetFilterMode (TextureFilterMode mode) |
| void | SetAddressMode (TextureCoordinate coord, TextureAddressMode mode) |
| void | SetAnisotropy (unsigned level) |
| void | SetShadowCompare (bool enable) |
| Set shadow compare mode. Not used on Direct3D9. | |
| void | SetBorderColor (const Color &color) |
| void | SetSRGB (bool enable) |
| void | SetBackupTexture (Texture *texture) |
| void | SetMipsToSkip (MaterialQuality quality, int toSkip) |
| unsigned | GetFormat () const |
| bool | IsCompressed () const |
| unsigned | GetLevels () const |
| int | GetWidth () const |
| int | GetHeight () const |
| int | GetDepth () const |
| Return depth. | |
| TextureFilterMode | GetFilterMode () const |
| TextureAddressMode | GetAddressMode (TextureCoordinate coord) const |
| unsigned | GetAnisotropy () const |
| bool | GetShadowCompare () const |
| Return whether shadow compare is enabled. Not used on Direct3D9. | |
| const Color & | GetBorderColor () const |
| bool | GetSRGB () const |
| int | GetMultiSample () const |
| bool | GetAutoResolve () const |
| bool | IsResolveDirty () const |
| bool | GetLevelsDirty () const |
| Texture * | GetBackupTexture () const |
| int | GetMipsToSkip (MaterialQuality quality) const |
| int | GetLevelWidth (unsigned level) const |
| int | GetLevelHeight (unsigned level) const |
| int | GetLevelDepth (unsigned level) const |
| Return mip level depth, or 0 if level does not exist. | |
| TextureUsage | GetUsage () const |
| unsigned | GetDataSize (int width, int height) const |
| Return data size in bytes for a rectangular region. | |
| unsigned | GetDataSize (int width, int height, int depth) const |
| Return data size in bytes for a volume region. | |
| unsigned | GetRowDataSize (int width) const |
| Return data size in bytes for a pixel or block row. | |
| unsigned | GetComponents () const |
| bool | GetParametersDirty () const |
| Return whether the parameters are dirty. | |
| void | SetParameters (XMLFile *file) |
| Set additional parameters from an XML file. | |
| void | SetParameters (const XMLElement &element) |
| Set additional parameters from an XML element. | |
| void | SetParametersDirty () |
| Mark parameters dirty. Called by Graphics. | |
| void | UpdateParameters () |
| Update dirty parameters to the texture object. Called by Graphics when assigning the texture. | |
| void * | GetShaderResourceView () const |
| Return shader resource view. Only used on Direct3D11. | |
| void * | GetSampler () const |
| Return sampler state object. Only used on Direct3D11. | |
| void * | GetResolveTexture () const |
| Return resolve texture. Only used on Direct3D11. | |
| unsigned | GetTarget () const |
| Return texture's target. Only used on OpenGL. | |
| unsigned | GetSRGBFormat (unsigned format) |
| void | SetResolveDirty (bool enable) |
| Set or clear the need resolve flag. Called internally by Graphics. | |
| void | SetLevelsDirty () |
| Set the mipmap levels dirty flag. Called internally by Graphics. | |
| void | RegenerateLevels () |
| Regenerate mipmap levels for a rendertarget after rendering and before sampling. Called internally by Graphics. No-op on Direct3D9. On OpenGL the texture must have been bound to work properly. | |
| Public Member Functions inherited from Urho3D::ResourceWithMetadata | |
| ResourceWithMetadata (Context *context) | |
| Construct. | |
| void | AddMetadata (const String &name, const Variant &value) |
| void | RemoveMetadata (const String &name) |
| Remove metadata variable. | |
| void | RemoveAllMetadata () |
| Remove all metadata variables. | |
| const Variant & | GetMetadata (const String &name) const |
| bool | HasMetadata () const |
| Public Member Functions inherited from Urho3D::Resource | |
| Resource (Context *context) | |
| Construct. | |
| bool | Load (Deserializer &source) |
| Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded. | |
| virtual bool | Save (Serializer &dest) const |
| Save resource. Return true if successful. | |
| bool | LoadFile (const String &fileName) |
| virtual bool | SaveFile (const String &fileName) const |
| void | SetName (const String &name) |
| void | SetMemoryUse (unsigned size) |
| Set memory use in bytes, possibly approximate. | |
| void | ResetUseTimer () |
| Reset last used timer. | |
| void | SetAsyncLoadState (AsyncLoadState newState) |
| Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user. | |
| const String & | GetName () const |
| StringHash | GetNameHash () const |
| Return name hash. | |
| unsigned | GetMemoryUse () const |
| unsigned | GetUseTimer () |
| AsyncLoadState | GetAsyncLoadState () const |
| Return the asynchronous loading state. | |
| Public Member Functions inherited from Urho3D::Object | |
| Object (Context *context) | |
| Construct. | |
| ~Object () override | |
| Destruct. Clean up self from event sender & receiver structures. | |
| virtual StringHash | GetType () const =0 |
| virtual const String & | GetTypeName () const =0 |
| virtual const TypeInfo * | GetTypeInfo () const =0 |
| Return type info. | |
| virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event. | |
| bool | IsInstanceOf (StringHash type) const |
| Check current instance is type of specified type. | |
| bool | IsInstanceOf (const TypeInfo *typeInfo) const |
| Check current instance is type of specified type. | |
| template<typename T > | |
| bool | IsInstanceOf () const |
| Check current instance is type of specified class. | |
| template<typename T > | |
| T * | Cast () |
| Cast the object to specified most derived class. | |
| template<typename T > | |
| const T * | Cast () const |
| Cast the object to specified most derived class. | |
| void | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event. | |
| void | SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| Subscribe to a specific sender's event. | |
| void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event. | |
| void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event. | |
| void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events. | |
| void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events. | |
| void | UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events). | |
| void | SendEvent (StringHash eventType) |
| Send event to all subscribers. | |
| void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers. | |
| VariantMap & | GetEventDataMap () const |
| Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps. | |
| template<typename... Args> | |
| void | SendEvent (StringHash eventType, Args... args) |
| Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another. | |
| Context * | GetContext () const |
| Return execution context. | |
| const Variant & | GetGlobalVar (StringHash key) const |
| const VariantMap & | GetGlobalVars () const |
| void | SetGlobalVar (StringHash key, const Variant &value) |
| Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type. | |
| Object * | GetEventSender () const |
| Return active event sender. Null outside event handling. | |
| EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling. | |
| bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender. | |
| bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event. | |
| bool | HasEventHandlers () const |
| Return whether has subscribed to any event. | |
| template<class T > | |
| T * | GetSubsystem () const |
| Template version of returning a subsystem. | |
| const String & | GetCategory () const |
| void | SetBlockEvents (bool block) |
| Block object from sending and receiving events. | |
| bool | GetBlockEvents () const |
| Return sending and receiving events blocking status. | |
| Public Member Functions inherited from Urho3D::RefCounted | |
| RefCounted () | |
| Construct. Allocate the reference count structure and set an initial self weak reference. | |
| virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist. | |
| RefCounted (const RefCounted &rhs)=delete | |
| Prevent copy construction. | |
| RefCounted & | operator= (const RefCounted &rhs)=delete |
| Prevent assignment. | |
| void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. | |
| void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. | |
| int | Refs () const |
| int | WeakRefs () const |
| RefCount * | RefCountPtr () |
| Return pointer to the reference count structure. | |
| Public Member Functions inherited from Urho3D::GPUObject | |
| GPUObject (Graphics *graphics) | |
| Construct with graphics subsystem pointer. | |
| virtual | ~GPUObject () |
| Destruct. Remove from the Graphics. | |
| void | ClearDataLost () |
| Clear the data lost flag. | |
| Graphics * | GetGraphics () const |
| Return the graphics subsystem associated with this GPU object. | |
| void * | GetGPUObject () const |
| Return the object pointer. Applicable only on Direct3D. | |
| unsigned | GetGPUObjectName () const |
| Return the object name. Applicable only on OpenGL. | |
| bool | IsDataLost () const |
| bool | HasPendingData () const |
| Return whether has pending data assigned while graphics context was lost. | |
Static Public Member Functions | |
| static void | RegisterObject (Context *context) |
| Register object factory. | |
| Static Public Member Functions inherited from Urho3D::Texture | |
| static unsigned | CheckMaxLevels (int width, int height, unsigned requestedLevels) |
| Check maximum allowed mip levels for a specific texture size. | |
| static unsigned | CheckMaxLevels (int width, int height, int depth, unsigned requestedLevels) |
| Check maximum allowed mip levels for a specific 3D texture size. | |
| static unsigned | GetSRVFormat (unsigned format) |
| static unsigned | GetDSVFormat (unsigned format) |
| static unsigned | GetExternalFormat (unsigned format) |
| static unsigned | GetDataType (unsigned format) |
| Static Public Member Functions inherited from Urho3D::Object | |
| static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static. | |
Protected Member Functions | |
| bool | Create () override |
| Create the GPU texture. | |
| Protected Member Functions inherited from Urho3D::Texture | |
| void | CheckTextureBudget (StringHash type) |
| Check whether texture memory budget has been exceeded. Free unused materials in that case to release the texture references. | |
| Protected Member Functions inherited from Urho3D::ResourceWithMetadata | |
| void | LoadMetadataFromXML (const XMLElement &source) |
| Load metadata from <metadata> children of XML element. | |
| void | LoadMetadataFromJSON (const JSONArray &array) |
| Load metadata from JSON array. | |
| void | SaveMetadataToXML (XMLElement &destination) const |
| Save as <metadata> children of XML element. | |
| void | CopyMetadata (const ResourceWithMetadata &source) |
| Copy metadata from another resource. | |
Private Member Functions | |
| URHO3D_OBJECT (TextureCube, Texture) | |
| void | HandleRenderSurfaceUpdate (StringHash eventType, VariantMap &eventData) |
| Handle render surface update event. | |
Private Attributes | |
| SharedPtr< RenderSurface > | renderSurfaces_ [MAX_CUBEMAP_FACES] |
| Render surfaces. | |
| unsigned | faceMemoryUse_ [MAX_CUBEMAP_FACES] {} |
| Memory use per face. | |
| Vector< SharedPtr< Image > > | loadImages_ |
| Face image files acquired during BeginLoad. | |
| SharedPtr< XMLFile > | loadParameters_ |
| Parameter file acquired during BeginLoad. | |
Additional Inherited Members | |
| Protected Attributes inherited from Urho3D::Texture | |
| unsigned | target_ {} |
| OpenGL target. | |
| void * | shaderResourceView_ {} |
| Direct3D11 shader resource view. | |
| void * | sampler_ {} |
| Direct3D11 sampler state object. | |
| void * | resolveTexture_ {} |
| Direct3D11 resolve texture object when multisample with autoresolve is used. | |
| unsigned | format_ {} |
| Texture format. | |
| TextureUsage | usage_ {TEXTURE_STATIC} |
| Texture usage type. | |
| unsigned | levels_ {} |
| Current mip levels. | |
| unsigned | requestedLevels_ {} |
| Requested mip levels. | |
| int | width_ {} |
| Texture width. | |
| int | height_ {} |
| Texture height. | |
| int | depth_ {} |
| Texture depth. | |
| bool | shadowCompare_ {} |
| Shadow compare mode. | |
| TextureFilterMode | filterMode_ {FILTER_DEFAULT} |
| Filtering mode. | |
| TextureAddressMode | addressModes_ [MAX_COORDS] {ADDRESS_WRAP, ADDRESS_WRAP, ADDRESS_WRAP} |
| Addressing mode. | |
| unsigned | anisotropy_ {} |
| Texture anisotropy level. | |
| unsigned | mipsToSkip_ [MAX_TEXTURE_QUALITY_LEVELS] {2, 1, 0} |
| Mip levels to skip when loading per texture quality setting. | |
| Color | borderColor_ |
| Border color. | |
| int | multiSample_ {1} |
| Multisampling level. | |
| bool | sRGB_ {} |
| sRGB sampling and writing mode flag. | |
| bool | parametersDirty_ {true} |
| Parameters dirty flag. | |
| bool | autoResolve_ {} |
| Multisampling autoresolve flag. | |
| bool | resolveDirty_ {} |
| Multisampling resolve needed -flag. | |
| bool | levelsDirty_ {} |
| Mipmap levels regeneration needed -flag. | |
| SharedPtr< Texture > | backupTexture_ |
| Backup texture. | |
| Protected Attributes inherited from Urho3D::Object | |
| Context * | context_ |
| Execution context. | |
| Protected Attributes inherited from Urho3D::GPUObject | |
| WeakPtr< Graphics > | graphics_ |
| Graphics subsystem. | |
| GPUObjectHandle | object_ {} |
| Object pointer or name. | |
| bool | dataLost_ {} |
| Data lost flag. | |
| bool | dataPending_ {} |
| Data pending flag. | |
Detailed Description
Cube texture resource.
Member Function Documentation
◆ GetRenderSurface()
|
inline |
Return render surface for one face.
Here is the caller graph for this function:
The documentation for this class was generated from the following files:
- Source/Urho3D/Graphics/TextureCube.h
- Source/Urho3D/Graphics/OpenGL/OGLTextureCube.cpp
- Source/Urho3D/Graphics/TextureCube.cpp