AZ::RHI::PipelineLibraryData Class Reference

#include <PipelineLibraryData.h>

Inherits AZStd::intrusive_base.

Public Member Functions
	AZ_CLASS_ALLOCATOR (PipelineLibraryData, SystemAllocator)
	AZ_TYPE_INFO (PipelineLibraryData, "{6A349BB4-4787-46B5-A70A-7BA90515391F}")
AZStd::span< const uint8_t >	GetData () const
	Returns the data payload which describes the platform-specific pipeline library data.

Static Public Member Functions
static void	Reflect (ReflectContext *reflectContext)
static ConstPtr< PipelineLibraryData >	Create (AZStd::vector< uint8_t > &&data)

Friends
class	PipelineLibrary
template<typename , typename >
struct	AnyTypeInfoConcept
template<typename , bool , bool >
struct	Serialize::InstanceFactory

Detailed Description

This class represents a blob of platform-specific PipelineLibrary data that can be serialized to and from disk, speeding up driver compilation time and memory consumption.

Pipeline state data is expensive to compile and results in a lot of duplicated memory when pipeline states have little variance (for example, the same byte code but different render state). The pipeline library allows the platform to de-duplicate these identical components. Since this data is platform and driver specific, it gets serialized as an opaque blob.

Another restriction enforced by certain platforms is that they won't actually copy the data, since it can be quite large. For example, if a pipeline library exists per thread, it is preferred to not copy the data N times.

Therefore, this class is designed to be immutable after creation and support reference counting. This allows the platform to safely hold a reference and guarantees that the memory is not mutated externally.

---

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

• Gems/Atom/RHI/Code/Include/Atom/RHI.Reflect/PipelineLibraryData.h