XII Release 0.1.0
Loading...
Searching...
No Matches
xiiDecalAtlasResource Class Referencefinal

Packed decal atlas with metadata mapping decal IDs to UV rectangles. More...

#include <DecalResource.h>

Inheritance diagram for xiiDecalAtlasResource:
[legend]

Public Member Functions

XII_ALWAYS_INLINE const xiiDecalAtlasResourceDescriptor & GetDescriptor () const
 Returns packed metadata. CPU layer images are released after successful upload.
XII_ALWAYS_INLINE xiiArrayPtr< const xiiDecalAtlasEntry > GetEntries () const
 Returns the array of entries in this atlas, which contains the metadata for all entries.
XII_ALWAYS_INLINE xiiSharedPtr< xiiGALTexture > GetGALTexture () const
 Returns the albedo atlas. Other channels have separate GPU textures.
XII_ALWAYS_INLINE xiiSharedPtr< xiiGALTexture > GetAlbedoTexture () const
 Returns the GPU texture for the albedo channel.
XII_ALWAYS_INLINE xiiSharedPtr< xiiGALTexture > GetNormalTexture () const
 Returns the GPU texture for the normal channel.
XII_ALWAYS_INLINE xiiSharedPtr< xiiGALTexture > GetMaterialTexture () const
 Returns the GPU texture for the material channel.
XII_ALWAYS_INLINE xiiSharedPtr< xiiGALTexture > GetEmissiveTexture () const
 Returns the GPU texture for the emissive channel.
XII_ALWAYS_INLINE xiiSharedPtr< xiiGALSampler > GetGALSampler () const
 Returns the sampler state used for sampling the atlas textures.
bool TryGetAtlasEntry (const xiiTempHashedString &sDecalId, const xiiDecalAtlasEntry *&out_pEntry) const
 Tries to find the atlas entry for the given decal ID. Returns true if found, false otherwise.
bool TryGetAtlasEntry (const xiiHashedString &sDecalId, const xiiDecalAtlasEntry *&out_pEntry) const
 Tries to find the atlas entry for the given decal ID. Returns true if found, false otherwise.
Public Member Functions inherited from xiiResource
XII_ALWAYS_INLINE xiiStringView GetResourceID () const
XII_ALWAYS_INLINE xiiUInt64 GetResourceIDHash () const
 Returns the hash of the unique ID.
void SetResourceDescription (xiiStringView sDescription)
const xiiString & GetResourceDescription () const
const xiiString & GetResourceIdOrDescription () const
XII_ALWAYS_INLINE xiiResourceState GetLoadingState () const
 Returns the current state in which this resource is in.
XII_ALWAYS_INLINE xiiUInt8 GetNumQualityLevelsDiscardable () const
XII_ALWAYS_INLINE xiiUInt8 GetNumQualityLevelsLoadable () const
 Returns how many quality levels the resource may additionally load.
float GetLoadingPriority (xiiTime now) const
 Returns the priority that is used by the resource manager to determine which resource to load next.
xiiResourcePriority GetPriority () const
 Returns the current resource priority.
void SetPriority (xiiResourcePriority priority)
 Changes the current resource priority.
XII_ALWAYS_INLINE const xiiBitflags< xiiResourceFlags > & GetBaseResourceFlags () const
 Returns the basic flags for the resource type. Mostly used the resource manager.
XII_ALWAYS_INLINE const MemoryUsage & GetMemoryUsage () const
 Returns the information about the current memory usage of the resource.
XII_ALWAYS_INLINE xiiTime GetLastAcquireTime () const
XII_ALWAYS_INLINE xiiInt32 GetReferenceCount () const
 Returns the reference count of this resource.
XII_ALWAYS_INLINE const xiiTimestamp & GetLoadedFileModificationTime () const
XII_ALWAYS_INLINE xiiUInt32 GetCurrentResourceChangeCounter () const
XII_ALWAYS_INLINE void IncResourceChangeCounter ()
 Allows to manually increase the resource change counter to signal that dependent code might need to update.
virtual void ResetResource ()
void PrintHandleStackTraces ()
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI * GetDynamicRTTI () const
bool IsInstanceOf (const xiiRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.

Private Member Functions

virtual xiiResourceLoadDescription UnloadData (Unload WhatToUnload) override
virtual xiiResourceLoadDescription UpdateContent (xiiStreamReader *pStream) override
virtual void UpdateMemoryUsage (MemoryUsage &out_NewMemoryUsage) override

Additional Inherited Members

Public Types inherited from xiiResource
enum class  DoUpdate : xiiUInt8 { OnMainThread = 0U , OnAnyThread }
 Specifies the thread type on which update operations should be performed. More...
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI * GetStaticRTTI ()
Public Attributes inherited from xiiResource
xiiEvent< const xiiResourceEvent &, xiiMutex > m_ResourceEvents
Protected Types inherited from xiiResource
enum class  Unload : xiiUInt8 { AllQualityLevels = 0U , OneQualityLevel }
Protected Member Functions inherited from xiiResource
 xiiResource (DoUpdate resourceUpdateThread, xiiUInt8 uiQualityLevelsLoadable)
 Default constructor.
virtual ~xiiResource ()
 virtual destructor.
MemoryUsage & ModifyMemoryUsage ()
 Non-const version for resources that want to write this variable directly.
void SetIsReloadable (bool bIsReloadable)
void SetHasLoadingFallback (bool bHasLoadingFallback)
 Used internally by the code injection macros.

Detailed Description

Packed decal atlas with metadata mapping decal IDs to UV rectangles.

Member Function Documentation

◆ UnloadData()

xiiResourceLoadDescription xiiDecalAtlasResource::UnloadData ( Unload WhatToUnload)
overrideprivatevirtual

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.

Implements xiiResource.

◆ UpdateContent()

xiiResourceLoadDescription xiiDecalAtlasResource::UpdateContent ( xiiStreamReader * 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.

Implements xiiResource.

◆ UpdateMemoryUsage()

void xiiDecalAtlasResource::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.

Implements xiiResource.


The documentation for this class was generated from the following files:
  • /home/runner/work/XII/XII/Source/Engine/GraphicsCore/Decals/DecalResource.h
  • /home/runner/work/XII/XII/Source/Engine/GraphicsCore/Decals/Implementation/DecalAtlasResource.cpp