Open 3D Engine Atom Gem API Reference
23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
Inherited by AZ::RPI::ImageSystem.
Public Member Functions | |
AZ_RTTI (ImageSystemInterface,"{C05FE364-927F-4669-ADDA-5562E20D5DC1}") | |
AZ_DISABLE_COPY_MOVE (ImageSystemInterface) | |
virtual const Data::Instance < Image > & | GetSystemImage (SystemImage systemImage) const =0 |
Returns a system image generated at runtime. | |
virtual const Data::Instance < AttachmentImage > & | GetSystemAttachmentImage (RHI::Format format)=0 |
virtual const Data::Instance < StreamingImagePool > & | GetSystemStreamingPool () const =0 |
Returns the system streaming image pool. | |
virtual const Data::Instance < StreamingImagePool > & | GetStreamingPool () const =0 |
virtual const Data::Instance < AttachmentImagePool > & | GetSystemAttachmentPool () const =0 |
Returns the system attachment image pool. Use this if you do not need a custom pool for your allocation. | |
virtual bool | RegisterAttachmentImage (AttachmentImage *attachmentImage)=0 |
virtual void | UnregisterAttachmentImage (AttachmentImage *attachmentImage)=0 |
Unregister an attachment image (if it's was registered) | |
virtual Data::Instance < AttachmentImage > | FindRegisteredAttachmentImage (const Name &uniqueName) const =0 |
virtual void | Update ()=0 |
Static Public Member Functions | |
static ImageSystemInterface * | Get () |
|
pure virtual |
Find an attachment image by its unique name (same as its attachment id) from registered attachment images. Note: only attachment image created with an unique name will be registered.
Implemented in AZ::RPI::ImageSystem.
|
pure virtual |
O3DE_DEPRECATION_NOTICE(GHI-12058)
Implemented in AZ::RPI::ImageSystem.
|
pure virtual |
Returns a system attachment image generated at runtime for the given format. Supports color, depth, and depth/stencil attachment images
Implemented in AZ::RPI::ImageSystem.
|
pure virtual |
Register an attachment image by its unique name (attachment id) Return false if the image was failed to register. It could be the image with same name was already registered. Note: this function is only intended to be used by AttachmentImage class Only attachment images created with an unique name will be registered
Implemented in AZ::RPI::ImageSystem.