Unigine::Texture Class

Interface for texture manipulation.

To use this class, include the UnigineTexture.h file.

Unigine::Texture Class

Members

---

virtual ~Texture ()

Virtual destructor.

static Ptr< Texture > create ()

Texture constructor.

Return value

Pointer to the created texture.

virtual int create (const ImagePtr & image, int flags) const =0

Create texture from image.

Arguments

• const ImagePtr & image - Image pointer.
• int flags - Texture flags.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int create2D (int width, int height, int format, int flags) const =0

Create 2D texture.

Arguments

• int width - Texture width.
• int height - Texture height.
• int format - Texture format.
• int flags - Texture flags.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int create3D (int width, int height, int depth, int format, int flags) const =0

Create 3D texture.

Arguments

• int width - Texture width.
• int height - Texture height.
• int depth - Texture depth.
• int format - Texture format.
• int flags - Texture flags.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int createCube (int width, int height, int format, int flags) const =0

Create Cube texture.

Arguments

• int width - Texture width.
• int height - Texture height.
• int format - Texture format.
• int flags - Texture flags.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int create2DArray (int width, int height, int num_layers, int format, int flags) const =0

Create 2D Array texture.

Arguments

• int width - Texture width.
• int height - Texture height.
• int num_layers - Texture layers.
• int format - Texture format.
• int flags - Texture flags.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int load (const char * name, int flags) const =0

Load texture from file.

Arguments

• const char * name - File name.
• int flags - Texture flags.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int setImage (const ImagePtr & image) const =0

Set texture data.

Arguments

• const ImagePtr & image - Image pointer.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int getImage (const ImagePtr & image) const =0

Get texture data.

Arguments

• const ImagePtr & image - Image pointer.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual void clear () const =0

Clear texture.

virtual void destroy () const =0

Destroy texture.

virtual int getType () const =0

Get the texture type.

Return value

Texture type.

virtual const char * getTypeName () const =0

Get the texture type name.

Return value

Texture type name.

virtual int getFormat () const =0

Get the texture format.

Return value

Texture format.

virtual const char * getFormatName () const =0

Get the texture format name.

Return value

Texture format name.

virtual int getWidth () const =0

Return the texture width.

Return value

Texture width.

virtual int getHeight () const =0

Return the texture height.

Return value

Texture height.

virtual int getDepth () const =0

Return the texture depth.

Return value

Texture depth.

virtual int getNumMipmaps () const =0

Return the texture mipmap count.

Return value

Texture mipmap count.

virtual int getNumLayers () const =0

Return the texture layer count.

Return value

Texture layer count.

virtual void setFlags (int flags) const =0

Set texture flags.

Arguments

• int flags - Texture flags.

virtual int isBilinear () const =0

Check texture filter.

Return value

Returns 1 if the texture filter is bilinear or trilinear.

virtual int isAnisotropy () const =0

Check texture anisotropy.

Return value

Returns 1 if the texture filter is anisotropy.

virtual int getMultisample () const =0

Return the multisample count.

Return value

Multisample count.

virtual int createMipmaps () const =0

Create mipmaps stack.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int copy2D () const =0

Copy 2D texture.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int copyCube () const =0

Copy Cube texture.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual void render2D () const =0

Render 2D texture.

virtual void render2DScreen () const =0

Render 2D Screen texture.

virtual void renderCube () const =0

Render Cube texture.

virtual void render2DArray () const =0

Render 2D Array texture.

virtual int isRenderFlipped () const =0

Check the texture orientation.

Return value

Returns 1 if the texture is flipped.

virtual void bindVertex (int unit) const =0

Bind vertex texture.

Arguments

• int unit - Texture unit.

virtual void unbindVertex (int unit) const =0

Unbind vertex texture.

Arguments

• int unit - Texture unit.

virtual void bindFragment (int unit) const =0

Bind fragment texture.

Arguments

• int unit - Texture unit.

virtual void unbindFragment (int unit) const =0

Unbind fragment texture.

Arguments

• int unit - Texture unit.

virtual void bindCompute (int unit) const =0

Bind compute texture.

Arguments

• int unit - Texture unit.

virtual void unbindCompute (int unit) const =0

Unbind compute texture.

Arguments

• int unit - Texture unit.

virtual int getGLTarget () const =0

Return OpenGL texture target.

virtual int getGLTextureID () const =0

Return OpenGL texture identifier.

virtual void * getD3D9Texture () const =0

Return Direct3D9 texture.

virtual void * getD3D9Surface2D () const =0

Return Direct3D9 surface 2D.

virtual void * getD3D9SurfaceCube () const =0

Return Direct3D9 surface Cube.

virtual void * getD3D11Texture () const =0

Return Direct3D11 texture.

virtual void * getD3D11ShaderResourceView () const =0

Return Direct3D11 render target view.

virtual void * getD3D11UnorderedAccessView () const =0

Return Direct3D11 render target view.

virtual void * getD3D11RenderTargetView () const =0

Return Direct3D11 render target view.

virtual void * getD3D11DepthStencilView () const =0

Return Direct3D11 depth stencil view.

virtual void * getD3D11RenderTargetView () const =0

Return Direct3D11 render target view.

virtual void * getD3D11DepthStencilView () const =0

Return Direct3D11 depth stencil view.

---

Unigine::Texture::anonymous_90 Enumeration

Unigine::Texture::anonymous_91 Enumeration

Unigine::Texture::anonymous_92 Enumeration