 |
ezEngine Release 26.9
|
|
ezEngine Release 26.9
|
#include <KrautGeneratorResource.h>
Public Member Functions | |
| const ezSharedPtr< ezKrautGeneratorResourceDescriptor > & | GetDescriptor () const |
| ezUInt32 | GetLodCount () const |
| Returns the number of runtime LODs (indices 1..N in the internal representation; excludes LOD0 full-detail). | |
| float | GetLodDistance (ezUInt32 uiLodIndex) const |
| Returns the max distance for a runtime LOD (0-based: 0 = first runtime LOD). | |
| ezKrautTreeResourceHandle | GetOrCreateTreeResource (ezUInt32 uiSeed) |
| bool | RequestLodMesh (ezKrautTreeResourceHandle hTree, ezUInt32 uiSeed, ezUInt32 uiLodIndex, bool bImmediate) 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 ezString & | GetResourceDescription () const |
| The resource description allows to store an additional string that might be more descriptive during debugging, than the unique ID. | |
| const ezString & | GetResourceIdOrDescription () const |
| The returns the resource description, if available, otherwise the resource ID. | |
| 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. | |
| 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. | |
| EZ_ALWAYS_INLINE const ezBitflags< ezResourceFlags > & | GetBaseResourceFlags () const |
| Returns the basic flags for the resource type. Mostly used the resource manager. | |
| EZ_ALWAYS_INLINE const MemoryUsage & | GetMemoryUsage () 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. | |
| EZ_ALWAYS_INLINE const ezTimestamp & | GetLoadedFileModificationTime () const |
| Returns the modification date of the file from which this resource was loaded. | |
| 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. | |
| 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. | |
| Public Member Functions inherited from ezReflectedClass | |
| virtual const ezRTTI * | GetDynamicRTTI () 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. | |
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. | |
| virtual void | UpdateMemoryUsage (MemoryUsage &out_NewMemoryUsage) override |
| This function must be overridden by all resource types. | |
Additional Inherited Members | |
| Public Types inherited from ezResource | |
| enum class | DoUpdate { OnMainThread , OnAnyThread , OnGraphicsResourceThreads } |
| Static Public Member Functions inherited from ezNoBase | |
| static const ezRTTI * | GetStaticRTTI () |
| Public Attributes inherited from ezResource | |
| ezEvent< const ezResourceEvent &, ezMutex > | m_ResourceEvents |
| Static Public Attributes inherited from ezResource | |
| static DoUpdate | UpdateGraphicsResource = ezResource::DoUpdate::OnAnyThread |
| Protected Types inherited from ezResource | |
| enum class | Unload { AllQualityLevels , OneQualityLevel } |
| Protected Member Functions inherited from ezResource | |
| ezResource (DoUpdate ResourceUpdateThread, ezUInt8 uiQualityLevelsLoadable) | |
| Default constructor. | |
| virtual | ~ezResource () |
| virtual destructor. | |
| MemoryUsage & | ModifyMemoryUsage () |
| 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. | |
| void | SetHasLoadingFallback (bool bHasLoadingFallback) |
| Used internally by the code injection macros. | |
Resource that holds the Kraut tree generator descriptor and manages per-seed ezKrautTreeResource instances.
A single generator resource is shared by all ezKrautTreeComponent instances that reference the same tree asset. For each random seed in use, the generator creates one ezKrautTreeResource and asynchronously fills it with mesh data, LOD by LOD.
LOD index 0 is the full-detail preview LOD used in the asset editor and is never auto-selected by distance at runtime. LOD indices 1..N are the runtime LODs selected by camera distance.
| ezKrautTreeResourceHandle ezKrautGeneratorResource::GetOrCreateTreeResource | ( | ezUInt32 | uiSeed | ) |
Returns (creating if needed) an empty tree resource skeleton for the given seed. Also queues async generation of the base data (tree structure + bounds).
| bool ezKrautGeneratorResource::RequestLodMesh | ( | ezKrautTreeResourceHandle | hTree, |
| ezUInt32 | uiSeed, | ||
| ezUInt32 | uiLodIndex, | ||
| bool | bImmediate | ||
| ) | const |
Requests that a specific LOD mesh be generated.
uiLodIndex 0 = full-detail LOD, 1..N = runtime LODs. When bImmediate is true, generation runs synchronously on the calling thread, which will block until the mesh is ready. Returns true if the LOD is already Ready.
|
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 ezResource.
|
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 ezResource.
|
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 ezResource.
1.9.8