Diligent Engine
 
Loading...
Searching...
No Matches
Diligent::ITextureVk Struct Referenceabstract

Exposes Vulkan-specific functionality of a texture object. More...

#include <TextureVk.h>

Inheritance diagram for Diligent::ITextureVk:
Diligent::ITexture Diligent::IDeviceObject Diligent.IObject

Public Member Functions

virtual VkImage DILIGENT_CALL_TYPE GetVkImage () const =0
 Returns Vulkan image handle.
 
virtual void DILIGENT_CALL_TYPE SetLayout (VkImageLayout Layout)=0
 Sets Vulkan image layout.
 
virtual VkImageLayout DILIGENT_CALL_TYPE GetLayout () const =0
 Returns current Vulkan image layout. If the state is unknown to the engine, returns VK_IMAGE_LAYOUT_UNDEFINED.
 
- Public Member Functions inherited from Diligent::ITexture
virtual const TextureDesc &DILIGENT_CALL_TYPE GetDesc () const override=0
 Returns the texture description used to create the object.
 
virtual void DILIGENT_CALL_TYPE CreateView (const TextureViewDesc &ViewDesc, ITextureView **ppView)=0
 Creates a new texture view.
 
virtual ITextureView *DILIGENT_CALL_TYPE GetDefaultView (TEXTURE_VIEW_TYPE ViewType)=0
 Returns the pointer to the default view.
 
virtual Uint64 DILIGENT_CALL_TYPE GetNativeHandle ()=0
 Returns native texture handle specific to the underlying graphics API.
 
virtual void DILIGENT_CALL_TYPE SetState (RESOURCE_STATE State)=0
 Sets the usage state for all texture subresources.
 
virtual RESOURCE_STATE DILIGENT_CALL_TYPE GetState () const =0
 Returns the internal texture state.
 
virtual const SparseTextureProperties &DILIGENT_CALL_TYPE GetSparseProperties () const =0
 Returns the sparse texture properties, see Diligent::SparseTextureProperties.
 
- Public Member Functions inherited from Diligent::IDeviceObject
virtual Int32 DILIGENT_CALL_TYPE GetUniqueID () const =0
 Returns unique identifier assigned to an object.
 
virtual void DILIGENT_CALL_TYPE SetUserData (IObject *pUserData)=0
 Stores a pointer to the user-provided data object.
 
virtual IObject *DILIGENT_CALL_TYPE GetUserData () const =0
 Returns a pointer to the user data object previously set with SetUserData() method.
 
- Public Member Functions inherited from Diligent.IObject
virtual void DILIGENT_CALL_TYPE QueryInterface (const INTERFACE_ID &IID, IObject **ppInterface)=0
 Queries the specific interface.
 
virtual ReferenceCounterValueType DILIGENT_CALL_TYPE AddRef ()=0
 Increments the number of strong references by 1.
 
virtual ReferenceCounterValueType DILIGENT_CALL_TYPE Release ()=0
 
virtual IReferenceCounters *DILIGENT_CALL_TYPE GetReferenceCounters () const =0
 

Detailed Description

Exposes Vulkan-specific functionality of a texture object.

Member Function Documentation

◆ GetVkImage()

virtual VkImage DILIGENT_CALL_TYPE Diligent::ITextureVk::GetVkImage ( ) const
pure virtual

Returns Vulkan image handle.

The application must not release the returned image

◆ SetLayout()

virtual void DILIGENT_CALL_TYPE Diligent::ITextureVk::SetLayout ( VkImageLayout Layout)
pure virtual

Sets Vulkan image layout.

Parameters
[in]Layout- Vulkan image layout to set.
Note
This function does not perform layout transition, but sets the internal texture state to match the given Vulkan layout.