|
Open 3D Engine Atom Gem API Reference
24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
|
Open 3D Engine Atom Gem API Reference
24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
Inherits AZ::RHI::BufferPool.
Public Member Functions | |
| AZ_RTTI (BufferPool, "F3DE9E13-12F2-489E-8665-6895FD7446C0", Base) | |
| AZ_CLASS_ALLOCATOR (BufferPool, AZ::SystemAllocator) | |
| Device & | GetDevice () const |
 Public Member Functions inherited from AZ::RHI::BufferPool | |
| ResultCode | Init (Device &device, const BufferPoolDescriptor &descriptor) |
| ResultCode | InitBuffer (const BufferInitRequest &request) |
| ResultCode | OrphanBuffer (Buffer &buffer) |
| ResultCode | MapBuffer (const BufferMapRequest &request, BufferMapResponse &response) |
| void | UnmapBuffer (Buffer &buffer) |
| ResultCode | StreamBuffer (const BufferStreamRequest &request) |
| const BufferPoolDescriptor & | GetDescriptor () const override final |
| Public Member Functions inherited from AZ::RHI::BufferPoolBase | |
| AZ_RTTI (BufferPoolBase, "{28D265BB-3B90-4676-BBA9-3F933F14CB01}", ResourcePool) | |
| Public Member Functions inherited from AZ::RHI::ResourcePool | |
| AZ_RTTI (ResourcePool, "{757EB674-25DC-4D00-9808-D3DAF33A4EFE}", DeviceObject) | |
| void | Shutdown () override final |
| Shuts down the pool. This method will shutdown all resources associated with the pool. | |
| template<typename ResourceType > | |
| void | ForEach (AZStd::function< void(ResourceType &)> callback) |
| template<typename ResourceType > | |
| void | ForEach (AZStd::function< void(const ResourceType &)> callback) const |
| uint32_t | GetResourceCount () const |
| Returns the number of resources in the pool. | |
| ResourcePoolResolver * | GetResolver () |
| Returns the resolver for this pool. | |
| const ResourcePoolResolver * | GetResolver () const |
| const HeapMemoryUsage & | GetHeapMemoryUsage (HeapMemoryLevel heapMemoryLevel) const |
| Returns the memory used by this pool for a specific heap type. | |
| const PoolMemoryUsage & | GetMemoryUsage () const |
| Returns the memory used by this pool. | |
| Public Member Functions inherited from AZ::RHI::DeviceObject | |
| AZ_RTTI (DeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object) | |
| bool | IsInitialized () const |
| Returns whether the device object is initialized. | |
| Device & | GetDevice () const |
| Public Member Functions inherited from AZ::RHI::Object | |
| AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}") | |
| void | SetName (const Name &name) |
| Sets the name of the object. | |
| const Name & | GetName () const |
| Returns the name set on the object by SetName. | |
| uint32_t | use_count () |
| Returns the current use count of the object. | |
Static Public Member Functions | |
| static RHI::Ptr< BufferPool > | Create () |
Additional Inherited Members | |
| Protected Types inherited from AZ::RHI::ResourcePool | |
| using | PlatformMethod = AZStd::function< RHI::ResultCode()> |
| A simple functor that returns a result code. | |
| Protected Member Functions inherited from AZ::RHI::BufferPool | |
| void | OnFrameBegin () override |
| bool | ValidateNotProcessingFrame () const |
| Protected Member Functions inherited from AZ::RHI::BufferPoolBase | |
| ResultCode | InitBuffer (Buffer *buffer, const BufferDescriptor &descriptor, PlatformMethod platformInitResourceMethod) |
| void | ValidateBufferMap (Buffer &buffer, bool isDataValid) |
| bool | ValidateBufferUnmap (Buffer &buffer) |
| uint32_t | GetMapRefCount () const |
| Protected Member Functions inherited from AZ::RHI::ResourcePool | |
| void | OnFrameBegin () override |
| void | OnFrameCompile () override |
| void | OnFrameEnd () override |
| void | SetResolver (AZStd::unique_ptr< ResourcePoolResolver > &&resolvePolicy) |
| ResultCode | Init (Device &device, const ResourcePoolDescriptor &descriptor, const PlatformMethod &initMethod) |
| ResultCode | InitResource (Resource *resource, const PlatformMethod &initResourceMethod) |
| bool | ValidateIsRegistered (const Resource *resource) const |
| bool | ValidateIsUnregistered (const Resource *resource) const |
| bool | ValidateIsInitialized () const |
| Validates that the resource pool is initialized and ready to service requests. | |
| bool | ValidateNotProcessingFrame () const |
| Validates that we are not in the frame processing phase. | |
| Protected Member Functions inherited from AZ::RHI::DeviceObject | |
| void | Init (Device &device) |
| The derived class should call this method to assign the device. | |
| Protected Member Functions inherited from AZ::RHI::Object | |
| void | add_ref () const |
| void | release () const |
| Protected Attributes inherited from AZ::RHI::ResourcePool | |
| PoolMemoryUsage | m_memoryUsage |
| Protected Attributes inherited from AZ::RHI::Object | |
| AZStd::atomic_int | m_useCount = 0 |
1.9.1