Diligent::ITexture struct
#include <Graphics/GraphicsEngine/interface/Texture.h>

Texture inteface.

Reference

Base classes

struct IDeviceObject: Base interface for all objects created by the render device Diligent::IRenderDevice.

Derived classes

struct ITextureD3D11: Exposes Direct3D11-specific functionality of a texture object.
struct ITextureD3D12: Exposes Direct3D12-specific functionality of a texture object.
struct ITextureGL: Exposes OpenGL-specific functionality of a texture object.
class ITextureMtl: Exposes Metal-specific functionality of a texture object.
struct ITextureVk: Exposes Vulkan-specific functionality of a texture object.

Public functions

auto GetDesc() const -> const TextureDesc&METHOD() override: Returns the texture description used to create the object.
auto CreateView(const TextureViewDesc& ViewDesc, ITextureView** ppView) -> void METHOD() virtual: Creates a new texture view.
auto GetDefaultView(TEXTURE_VIEW_TYPE ViewType) -> ITextureView*METHOD() virtual: Returns the pointer to the default view.
auto GetNativeHandle() -> void*METHOD() virtual: Returns native texture handle specific to the underlying graphics API.
auto SetState(RESOURCE_STATE State) -> void METHOD() virtual: Sets the usage state for all texture subresources.
auto GetState() const -> RESOURCE_STATE METHOD() virtual: Returns the internal texture state.

Function documentation

void METHOD() Diligent::ITexture::CreateView(const TextureViewDesc& ViewDesc, ITextureView** ppView) virtual

Creates a new texture view.

Parameters
ViewDesc in	- View description. See Diligent::TextureViewDesc for details.
ppView out	- Address of the memory location where the pointer to the view interface will be written to.

Remark

To create a shader resource view addressing the entire texture, set only TextureViewDesc::ViewType member of the ViewDesc parameter to Diligent::TEXTURE_VIEW_SHADER_RESOURCE and leave all other members in their default values. Using the same method, you can create render target or depth stencil view addressing the largest mip level.
If texture view format is Diligent::TEX_FORMAT_UNKNOWN, the view format will match the texture format.
If texture view type is Diligent::TEXTURE_VIEW_UNDEFINED, the type will match the texture type.
If the number of mip levels is 0, and the view type is shader resource, the view will address all mip levels. For other view types it will address one mip level.
If the number of slices is 0, all slices from FirstArraySlice or FirstDepthSlice will be referenced by the view. For non-array textures, the only allowed values for the number of slices are 0 and 1.
Texture view will contain strong reference to the texture, so the texture will not be destroyed until all views are released.
The function calls AddRef() for the created interface, so it must be released by a call to Release() when it is no longer needed.

ITextureView*METHOD() Diligent::ITexture::GetDefaultView(TEXTURE_VIEW_TYPE ViewType) virtual

Returns the pointer to the default view.

Parameters
ViewType in	- Type of the requested view. See Diligent::TEXTURE_VIEW_TYPE.
Returns	Pointer to the interface

void*METHOD() Diligent::ITexture::GetNativeHandle() virtual

Returns native texture handle specific to the underlying graphics API.

Returns	pointer to ID3D11Resource interface, for D3D11 implementation pointer to ID3D12Resource interface, for D3D12 implementation GL buffer handle, for GL implementation

void METHOD() Diligent::ITexture::SetState(RESOURCE_STATE State) virtual

Sets the usage state for all texture subresources.