ezEngine  Release 25.03
ezRenderToTexture2DResource Class Reference
Inheritance diagram for ezRenderToTexture2DResource:

Public Member Functions

ezGALRenderTargetViewHandle GetRenderTargetView () const
 
void AddRenderView (ezViewHandle hView)
 
void RemoveRenderView (ezViewHandle hView)
 
const ezDynamicArray< ezViewHandle > & GetAllRenderViews () const
 
- Public Member Functions inherited from ezTexture2DResource
EZ_ALWAYS_INLINE ezGALResourceFormat::Enum GetFormat () const
 
EZ_ALWAYS_INLINE ezUInt32 GetWidth () const
 
EZ_ALWAYS_INLINE ezUInt32 GetHeight () const
 
EZ_ALWAYS_INLINE ezGALTextureType::Enum GetType () const
 
const ezGALTextureHandleGetGALTexture () const
 
const ezGALSamplerStateHandleGetGALSamplerState () const
 
- Public Member Functions inherited from ezResource
EZ_ALWAYS_INLINE ezStringView GetResourceID () const
 Returns the unique ID that identifies this resource. On a file resource this might be a path. Can also be a GUID or any other scheme that uniquely identifies the resource.
 
EZ_ALWAYS_INLINE ezUInt64 GetResourceIDHash () const
 Returns the hash of the unique ID.
 
void SetResourceDescription (ezStringView sDescription)
 The resource description allows to store an additional string that might be more descriptive during debugging, than the unique ID.
 
const ezStringGetResourceDescription () const
 The resource description allows to store an additional string that might be more descriptive during debugging, than the unique ID.
 
const ezStringGetResourceIdOrDescription () const
 The returns the resource description, if available, otherwise the resource ID. More...
 
EZ_ALWAYS_INLINE ezResourceState GetLoadingState () const
 Returns the current state in which this resource is in.
 
EZ_ALWAYS_INLINE ezUInt8 GetNumQualityLevelsDiscardable () const
 Returns the current maximum quality level that the resource could have. More...
 
EZ_ALWAYS_INLINE ezUInt8 GetNumQualityLevelsLoadable () const
 Returns how many quality levels the resource may additionally load.
 
float GetLoadingPriority (ezTime now) const
 Returns the priority that is used by the resource manager to determine which resource to load next.
 
ezResourcePriority GetPriority () const
 Returns the current resource priority.
 
void SetPriority (ezResourcePriority priority)
 Changes the current resource priority.
 
const EZ_ALWAYS_INLINE ezBitflags< ezResourceFlags > & GetBaseResourceFlags () const
 Returns the basic flags for the resource type. Mostly used the resource manager.
 
const EZ_ALWAYS_INLINE MemoryUsageGetMemoryUsage () const
 Returns the information about the current memory usage of the resource.
 
EZ_ALWAYS_INLINE ezTime GetLastAcquireTime () const
 Returns the time at which the resource was (tried to be) acquired last. If a resource is acquired using ezResourceAcquireMode::PointerOnly, this does not update the last acquired time, since the resource is not acquired for full use.
 
EZ_ALWAYS_INLINE ezInt32 GetReferenceCount () const
 Returns the reference count of this resource.
 
const EZ_ALWAYS_INLINE ezTimestampGetLoadedFileModificationTime () const
 Returns the modification date of the file from which this resource was loaded. More...
 
EZ_ALWAYS_INLINE ezUInt32 GetCurrentResourceChangeCounter () const
 Returns the current value of the resource change counter. Can be used to detect whether the resource has changed since using it last time. More...
 
EZ_ALWAYS_INLINE void IncResourceChangeCounter ()
 Allows to manually increase the resource change counter to signal that dependent code might need to update.
 
virtual void ResetResource ()
 If the resource has modifications from the original state, it should reset itself to that state now (or force a reload on itself).
 
void PrintHandleStackTraces ()
 Prints the stack-traces for all handles that currently reference this resource. More...
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Protected Attributes

ezDynamicArray< ezViewHandlem_RenderViews
 
- Protected Attributes inherited from ezTexture2DResource
ezUInt8 m_uiLoadedTextures = 0
 
ezGALTextureHandle m_hGALTexture [2]
 
ezUInt32 m_uiMemoryGPU [2] = {0, 0}
 
ezGALTextureType::Enum m_Type = ezGALTextureType::Invalid
 
ezGALResourceFormat::Enum m_Format = ezGALResourceFormat::Invalid
 
ezUInt32 m_uiWidth = 0
 
ezUInt32 m_uiHeight = 0
 
ezGALSamplerStateHandle m_hSamplerState
 

Private Member Functions

virtual ezResourceLoadDesc UnloadData (Unload WhatToUnload) override
 Requests the resource to unload another quality level. If bFullUnload is true, the resource should unload all data, because it is going to be deleted afterwards.
 
virtual ezResourceLoadDesc UpdateContent (ezStreamReader *Stream) override
 Called whenever more data for the resource is available. The resource must read the stream to update it's data. More...
 
virtual void UpdateMemoryUsage (MemoryUsage &out_NewMemoryUsage) override
 This function must be overridden by all resource types. More...
 

Additional Inherited Members

- Public Types inherited from ezResource
enum  DoUpdate { OnMainThread, OnAnyThread, DoUpdate::OnGraphicsResourceThreads }
 
- Static Public Member Functions inherited from ezTexture2DResource
static void FillOutDescriptor (ezTexture2DResourceDescriptor &ref_td, const ezImage *pImage, bool bSRGB, ezUInt32 uiNumMipLevels, ezUInt32 &out_uiMemoryUsed, ezHybridArray< ezGALSystemMemoryDescription, 32 > &ref_initData)
 
- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 
- Public Attributes inherited from ezResource
ezEvent< const ezResourceEvent &, ezMutexm_ResourceEvents
 
- Static Public Attributes inherited from ezResource
static DoUpdate UpdateGraphicsResource = ezResource::DoUpdate::OnAnyThread
 
- Protected Types inherited from ezResource
enum  Unload { AllQualityLevels, OneQualityLevel }
 
- Protected Member Functions inherited from ezTexture2DResource
 ezTexture2DResource (DoUpdate ResourceUpdateThread)
 
- Protected Member Functions inherited from ezResource
 ezResource (DoUpdate ResourceUpdateThread, ezUInt8 uiQualityLevelsLoadable)
 Default constructor.
 
virtual ~ezResource ()
 virtual destructor.
 
MemoryUsageModifyMemoryUsage ()
 Non-const version for resources that want to write this variable directly.
 
void SetIsReloadable (bool bIsReloadable)
 Call this to specify whether a resource is reloadable. More...
 
void SetHasLoadingFallback (bool bHasLoadingFallback)
 Used internally by the code injection macros.
 

Member Function Documentation

◆ UpdateContent()

ezResourceLoadDesc ezRenderToTexture2DResource::UpdateContent ( ezStreamReader pStream)
overrideprivatevirtual

Called whenever more data for the resource is available. The resource must read the stream to update it's data.

pStream may be nullptr in case the resource data could not be found.

Reimplemented from ezTexture2DResource.

◆ UpdateMemoryUsage()

void ezRenderToTexture2DResource::UpdateMemoryUsage ( MemoryUsage out_NewMemoryUsage)
overrideprivatevirtual

This function must be overridden by all resource types.

It has to compute the memory used by this resource. It is called by the resource manager whenever the resource's data has been loaded or unloaded.

Reimplemented from ezTexture2DResource.


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