Graphic3d_TextureEnv Class Reference
This class provides environment texture. More...
#include <Graphic3d_TextureEnv.hxx>
Inheritance diagram for Graphic3d_TextureEnv:
Public Member Functions | |
| Graphic3d_TextureEnv (const TCollection_AsciiString &theFileName) | |
| Creates an environment texture from a file. | |
| Graphic3d_TextureEnv (const Graphic3d_NameOfTextureEnv theName) | |
| Creates an environment texture from a predefined texture name set. | |
| Graphic3d_TextureEnv (const Handle< Image_PixMap > &thePixMap) | |
| Creates an environment texture from the pixmap. | |
| Graphic3d_NameOfTextureEnv | Name () const |
| Returns the name of the predefined textures or NOT_ENV_UNKNOWN when the name is given as a filename. | |
 Public Member Functions inherited from Graphic3d_TextureRoot | |
| ~Graphic3d_TextureRoot () | |
| Destructor. | |
| virtual Standard_Boolean | IsDone () const |
| Checks if a texture class is valid or not. | |
| const OSD_Path & | Path () const |
| Returns the full path of the defined texture. It could be empty path if GetImage() is overridden to load image not from file. | |
| Graphic3d_TypeOfTexture | Type () const |
| const TCollection_AsciiString & | GetId () const |
| This ID will be used to manage resource in graphic driver. | |
| Standard_Size | Revision () const |
| Return image revision. | |
| void | UpdateRevision () |
| Update image revision. Can be used for signaling changes in the texture source (e.g. file update, pixmap update) without re-creating texture source itself (since unique id should be never modified). | |
| virtual Handle< Image_CompressedPixMap > | GetCompressedImage (const Handle< Image_SupportedFormats > &theSupported) |
| This method will be called by graphic driver each time when texture resource should be created. It is called in front of GetImage() for uploading compressed image formats natively supported by GPU. | |
| virtual Handle< Image_PixMap > | GetImage (const Handle< Image_SupportedFormats > &theSupported) |
| This method will be called by graphic driver each time when texture resource should be created. Default constructors allow defining the texture source as path to texture image or directly as pixmap. If the source is defined as path, then the image will be dynamically loaded when this method is called (and no copy will be preserved in this class instance). Inheritors may dynamically generate the image. Notice, image data should be in Bottom-Up order (see Image_PixMap::IsTopDown())! | |
| const Handle< Graphic3d_TextureParams > & | GetParams () const |
| Standard_Boolean | IsColorMap () const |
| Return flag indicating color nature of values within the texture; TRUE by default. | |
| void | SetColorMap (Standard_Boolean theIsColor) |
| Set flag indicating color nature of values within the texture. | |
| Standard_Boolean | HasMipmaps () const |
| Returns whether mipmaps should be generated or not. | |
| void | SetMipmapsGeneration (Standard_Boolean theToGenerateMipmaps) |
| Sets whether to generate mipmaps or not. | |
| Standard_Boolean | IsTopDown () const |
| Returns whether row's memory layout is top-down. | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Static Public Member Functions | |
| static Standard_Integer | NumberOfTextures () |
| Returns the number of predefined textures. | |
| static TCollection_AsciiString | TextureName (const Standard_Integer theRank) |
| Returns the name of the predefined texture of rank <aRank> | |
| Static Public Member Functions inherited from Graphic3d_TextureRoot | |
| static TCollection_AsciiString | TexturesFolder () |
| The path to textures determined from CSF_MDTVTexturesDirectory or CASROOT environment variables. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Protected Member Functions inherited from Graphic3d_TextureRoot | |
| Graphic3d_TextureRoot (const TCollection_AsciiString &theFileName, const Graphic3d_TypeOfTexture theType) | |
| Creates a texture from a file Warning: Note that if <FileName> is NULL the texture must be realized using LoadTexture(image) method. | |
| Graphic3d_TextureRoot (const Handle< Image_PixMap > &thePixmap, const Graphic3d_TypeOfTexture theType) | |
| Creates a texture from pixmap. Please note that the implementation expects the image data to be in Bottom-Up order (see Image_PixMap::IsTopDown()). | |
| void | generateId () |
| Unconditionally generate new texture id. Should be called only within constructor. | |
| virtual Handle< Image_PixMap > | GetImage () const |
| Method for supporting old API; another GetImage() method should be implemented instead. | |
| Static Protected Member Functions inherited from Graphic3d_TextureRoot | |
| static void | convertToCompatible (const Handle< Image_SupportedFormats > &theSupported, const Handle< Image_PixMap > &theImage) |
| Try converting image to compatible format. | |
| Protected Attributes inherited from Graphic3d_TextureRoot | |
| Handle< Graphic3d_TextureParams > | myParams |
| associated texture parameters | |
| TCollection_AsciiString | myTexId |
| unique identifier of this resource (for sharing graphic resource); should never be modified outside constructor | |
| Handle< Image_PixMap > | myPixMap |
| image pixmap - as one of the ways for defining the texture source | |
| OSD_Path | myPath |
| image file path - as one of the ways for defining the texture source | |
| Standard_Size | myRevision |
| image revision - for signaling changes in the texture source (e.g. file update, pixmap update) | |
| Graphic3d_TypeOfTexture | myType |
| texture type | |
| Standard_Boolean | myIsColorMap |
| flag indicating color nature of values within the texture | |
| Standard_Boolean | myIsTopDown |
| Stores rows's memory layout. | |
| Standard_Boolean | myHasMipmaps |
| Indicates whether mipmaps should be generated or not. | |
Detailed Description
This class provides environment texture.
Constructor & Destructor Documentation
◆ Graphic3d_TextureEnv() [1/3]
| Graphic3d_TextureEnv::Graphic3d_TextureEnv | ( | const TCollection_AsciiString & | theFileName | ) |
Creates an environment texture from a file.
◆ Graphic3d_TextureEnv() [2/3]
| Graphic3d_TextureEnv::Graphic3d_TextureEnv | ( | const Graphic3d_NameOfTextureEnv | theName | ) |
Creates an environment texture from a predefined texture name set.
◆ Graphic3d_TextureEnv() [3/3]
| Graphic3d_TextureEnv::Graphic3d_TextureEnv | ( | const Handle< Image_PixMap > & | thePixMap | ) |
Creates an environment texture from the pixmap.
Member Function Documentation
◆ Name()
| Graphic3d_NameOfTextureEnv Graphic3d_TextureEnv::Name | ( | ) | const |
Returns the name of the predefined textures or NOT_ENV_UNKNOWN when the name is given as a filename.
◆ NumberOfTextures()
|
static |
Returns the number of predefined textures.
◆ TextureName()
|
static |
Returns the name of the predefined texture of rank <aRank>
The documentation for this class was generated from the following file:
Generated by
1.12.0