FD3D11Texture Class Reference

#include <D3D11Resources.h>

Inheritance diagram for FD3D11Texture:

Public Types
enum	EAliasResourceParam { CreateAlias }

Public Member Functions
	FD3D11Texture (const FRHITextureCreateDesc &InDesc)
void	FinalizeCreation (ID3D11Resource *InResource, ID3D11ShaderResourceView *InShaderResourceView, int32 InRTVArraySize, bool bInCreatedRTVsPerSlice, TConstArrayView< TRefCountPtr< ID3D11RenderTargetView > > InRenderTargetViews, TConstArrayView< TRefCountPtr< ID3D11DepthStencilView > > InDepthStencilViews)
	FD3D11Texture (const FRHITextureCreateDesc &InDesc, ID3D11Resource *InResource, ID3D11ShaderResourceView *InShaderResourceView, int32 InRTVArraySize, bool bInCreatedRTVsPerSlice, TConstArrayView< TRefCountPtr< ID3D11RenderTargetView > > InRenderTargetViews, TConstArrayView< TRefCountPtr< ID3D11DepthStencilView > > InDepthStencilViews)
D3D11RHI_API	FD3D11Texture (FD3D11Texture const &Other, const FString &Name, EAliasResourceParam)
D3D11RHI_API void	AliasResource (FD3D11Texture const &Other)
virtual D3D11RHI_API	~FD3D11Texture ()
uint64	GetMemorySize () const
ID3D11Resource *	GetResource () const
ID3D11ShaderResourceView *	GetShaderResourceView () const
bool	IsCubemap () const
ID3D11Texture2D *	GetD3D11Texture2D () const
ID3D11Texture3D *	GetD3D11Texture3D () const
bool	IsTexture3D () const
virtual void *	GetNativeResource () const override
virtual void *	GetNativeShaderResourceView () const override
virtual void *	GetTextureBaseRHI () override
void	SetIHVResourceHandle (void *InHandle)
void *	GetIHVResourceHandle () const
ID3D11RenderTargetView *	GetRenderTargetView (int32 MipIndex, int32 ArraySliceIndex) const
ID3D11DepthStencilView *	GetDepthStencilView (FExclusiveDepthStencil AccessType) const
FRHILockTextureResult	Lock (FD3D11DynamicRHI *D3DRHI, const FRHILockTextureArgs &Arguments, bool bForceLockDeferred)
void	Unlock (FD3D11DynamicRHI *D3DRHI, const FRHILockTextureArgs &Arguments)
Public Member Functions inherited from FRHITexture
virtual const FRHITextureDesc &	GetDesc () const
virtual class FRHITextureReference *	GetTextureReference ()
virtual FRHIDescriptorHandle	GetDefaultBindlessHandle () const
virtual void	GetWriteMaskProperties (void *&OutData, uint32 &OutSize)
FIntVector	GetSizeXYZ () const
FIntVector	GetMipDimensions (uint8 MipIndex) const
bool	IsMultisampled () const
bool	HasClearValue () const
FLinearColor	GetClearColor () const
void	GetDepthStencilClearValue (float &OutDepth, uint32 &OutStencil) const
float	GetDepthClearValue () const
uint32	GetStencilClearValue () const
void	SetLastRenderTime (float InLastRenderTime)
double	GetLastRenderTime () const
RHI_API void	SetName (FName InName)
FRHITexture *	GetTexture2D ()
FRHITexture *	GetTexture2DArray ()
FRHITexture *	GetTexture3D ()
FRHITexture *	GetTextureCube ()
uint32	GetSizeX () const
uint32	GetSizeY () const
FIntPoint	GetSizeXY () const
uint32	GetSizeZ () const
uint32	GetNumMips () const
EPixelFormat	GetFormat () const
ETextureCreateFlags	GetFlags () const
uint32	GetNumSamples () const
const FClearValueBinding	GetClearBinding () const
uint32	GetSize () const
Public Member Functions inherited from FRHIViewableResource
ERHIAccess	GetTrackedAccess_Unsafe () const
FName	GetName () const
Public Member Functions inherited from FRHIResource
RHI_API	FRHIResource (ERHIResourceType InResourceType)
uint32	AddRef () const
uint32	Release () const
uint32	GetRefCount () const
bool	IsValid () const
void	DisableLifetimeExtension ()
ERHIResourceType	GetType () const
FName	GetOwnerName () const
void	SetOwnerName (FName InOwnerName)
Public Member Functions inherited from FD3D11ViewableResource
	~FD3D11ViewableResource ()
bool	HasLinkedViews () const
void	UpdateLinkedViews ()

Additional Inherited Members
Protected Member Functions inherited from FRHITexture
	FRHITexture ()=delete
RHI_API	FRHITexture (const FRHITextureCreateDesc &CreateDesc)
RHI_API	FRHITexture (ERHIResourceType InResourceType)
Protected Member Functions inherited from FRHIViewableResource
	FRHIViewableResource (ERHIResourceType InResourceType, ERHIAccess InAccess, const TCHAR *InName, FName InOwnerName)
virtual void	SetTrackedAccessFromContext (FRHITrackedAccess InTrackedAccess)
void	TakeOwnership (FRHIViewableResource &Other)
void	ReleaseOwnership ()
Protected Member Functions inherited from FRHIResource
virtual RHI_API	~FRHIResource ()
Protected Attributes inherited from FRHIViewableResource
FName	Name

Detailed Description

Texture base class.

Member Enumeration Documentation

EAliasResourceParam

enum FD3D11Texture::EAliasResourceParam

Enumerator
CreateAlias

Constructor & Destructor Documentation

FD3D11Texture() [1/3]

FD3D11Texture::FD3D11Texture

(

const FRHITextureCreateDesc &

InDesc

)

FD3D11Texture() [2/3]

FD3D11Texture::FD3D11Texture ( const FRHITextureCreateDesc &  InDesc, ID3D11Resource *  InResource, ID3D11ShaderResourceView *  InShaderResourceView, int32  InRTVArraySize, bool  bInCreatedRTVsPerSlice, TConstArrayView< TRefCountPtr< ID3D11RenderTargetView > >  InRenderTargetViews, TConstArrayView< TRefCountPtr< ID3D11DepthStencilView > >  InDepthStencilViews  )

inline

FD3D11Texture() [3/3]

FD3D11Texture::FD3D11Texture ( FD3D11Texture const &  Other, const FString &  Name, EAliasResourceParam    )

explicit

~FD3D11Texture()

FD3D11Texture::~FD3D11Texture ( )

virtual

Member Function Documentation

AliasResource()

void FD3D11Texture::AliasResource

(

FD3D11Texture const &

Other

)

FinalizeCreation()

void FD3D11Texture::FinalizeCreation	(	ID3D11Resource *	InResource,
		ID3D11ShaderResourceView *	InShaderResourceView,
		int32	InRTVArraySize,
		bool	bInCreatedRTVsPerSlice,
		TConstArrayView< TRefCountPtr< ID3D11RenderTargetView > >	InRenderTargetViews,
		TConstArrayView< TRefCountPtr< ID3D11DepthStencilView > >	InDepthStencilViews
	)

GetD3D11Texture2D()

ID3D11Texture2D * FD3D11Texture::GetD3D11Texture2D ( ) const

inline

GetD3D11Texture3D()

ID3D11Texture3D * FD3D11Texture::GetD3D11Texture3D ( ) const

inline

GetDepthStencilView()

ID3D11DepthStencilView * FD3D11Texture::GetDepthStencilView ( FExclusiveDepthStencil  AccessType ) const

inline

GetIHVResourceHandle()

void * FD3D11Texture::GetIHVResourceHandle ( ) const

inline

GetMemorySize()

uint64 FD3D11Texture::GetMemorySize ( ) const

inline

GetNativeResource()

virtual void * FD3D11Texture::GetNativeResource ( ) const

inlineoverridevirtual

Returns access to the platform-specific native resource pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.

Returns

The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

Reimplemented from FRHITexture.

GetNativeShaderResourceView()

virtual void * FD3D11Texture::GetNativeShaderResourceView ( ) const

inlineoverridevirtual

Returns access to the platform-specific native shader resource view pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.

Returns

The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

Reimplemented from FRHITexture.

GetRenderTargetView()

ID3D11RenderTargetView * FD3D11Texture::GetRenderTargetView ( int32  MipIndex, int32  ArraySliceIndex  ) const

inline

Get the render target view for the specified mip and array slice. An array slice of -1 is used to indicate that no array slice should be required.

GetResource()

ID3D11Resource * FD3D11Texture::GetResource ( ) const

inline

GetShaderResourceView()

ID3D11ShaderResourceView * FD3D11Texture::GetShaderResourceView ( ) const

inline

GetTextureBaseRHI()

virtual void * FD3D11Texture::GetTextureBaseRHI ( )

inlineoverridevirtual

Returns access to the platform-specific RHI texture baseclass. This is designed to provide the RHI with fast access to its base classes in the face of multiple inheritance.

Returns

The pointer to the platform-specific RHI texture baseclass or NULL if it not initialized or not supported for this RHI

Reimplemented from FRHITexture.

IsCubemap()

bool FD3D11Texture::IsCubemap ( ) const

inline

IsTexture3D()

bool FD3D11Texture::IsTexture3D ( ) const

inline

Lock()

FRHILockTextureResult FD3D11Texture::Lock	(	FD3D11DynamicRHI *	D3DRHI,
		const FRHILockTextureArgs &	Arguments,
		bool	bForceLockDeferred
	)

Locks one of the texture's mip-maps.

Returns

A pointer to the specified texture data.

SetIHVResourceHandle()

void FD3D11Texture::SetIHVResourceHandle ( void *  InHandle )

inline

Unlock()

void FD3D11Texture::Unlock	(	FD3D11DynamicRHI *	D3DRHI,
		const FRHILockTextureArgs &	Arguments
	)

Unlocks a previously locked mip-map.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Windows/D3D11RHI/Public/D3D11Resources.h
• Engine/Source/Runtime/Windows/D3D11RHI/Private/D3D11Texture.cpp