Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::AssetSerializer Class Reference

#include <AssetSerializer.h>

Inherits AZ::Serialize::IDataSerializer.

Public Member Functions

size_t Save (const void *classPtr, IO::GenericStream &stream, bool isDataBigEndian=false) override
 Store the class data into a stream.
 
size_t DataToText (IO::GenericStream &in, IO::GenericStream &out, bool isDataBigEndian) override
 Convert binary data to text.
 
size_t TextToData (const char *text, unsigned int textVersion, IO::GenericStream &stream, bool isDataBigEndian) override
 Convert text data to binary, to support loading old version formats. We must respect text version if the text->binary format has changed!
 
bool Load (void *classPtr, IO::GenericStream &stream, unsigned int version, bool isDataBigEndian) override
 Load the class data from a stream.
 
bool LoadWithFilter (void *classPtr, IO::GenericStream &stream, unsigned int version, const Data::AssetFilterCB &assetFilterCallback, bool isDataBigEndian=false)
 
void Clone (const void *sourcePtr, void *destPtr)
 
bool CompareValueData (const void *lhs, const void *rhs) override
 
- Public Member Functions inherited from AZ::Serialize::IDataSerializer
virtual size_t Save (const void *classPtr, IO::GenericStream &stream, bool isDataBigEndian=false)=0
 Store the class data into a stream.
 
virtual bool Load (void *classPtr, IO::GenericStream &stream, unsigned int version, bool isDataBigEndian=false)=0
 Load the class data from a stream.
 
virtual size_t DataToText (IO::GenericStream &in, IO::GenericStream &out, bool isDataBigEndian)=0
 Convert binary data to text.
 
virtual size_t TextToData (const char *text, unsigned int textVersion, IO::GenericStream &stream, bool isDataBigEndian=false)=0
 Convert text data to binary, to support loading old version formats. We must respect text version if the text->binary format has changed!
 
virtual bool CompareValueData (const void *lhs, const void *rhs)=0
 
virtual void PostClone (void *)
 Optional post processing of the cloned data to deal with members that are not serialize-reflected.
 

Static Public Attributes

static AssetSerializer s_serializer
 

Additional Inherited Members

- Static Public Member Functions inherited from AZ::Serialize::IDataSerializer
static IDataSerializerDeleter CreateDefaultDeleteDeleter ()
 
static IDataSerializerDeleter CreateNoDeleteDeleter ()
 

Detailed Description

Generic IDataSerializer specialization for Asset<T> This is used internally by the object stream because assets need special handling during serialization

Member Function Documentation

◆ CompareValueData()

bool AZ::AssetSerializer::CompareValueData ( const void *  lhs,
const void *  rhs 
)
overridevirtual

Compares two instances of the type.

Returns
true if they match. Note: Input pointers are assumed to point to valid instances of the class.

Implements AZ::Serialize::IDataSerializer.

◆ DataToText()

size_t AZ::AssetSerializer::DataToText ( IO::GenericStream in,
IO::GenericStream out,
bool  isDataBigEndian 
)
overridevirtual

Convert binary data to text.

Implements AZ::Serialize::IDataSerializer.

◆ Load()

bool AZ::AssetSerializer::Load ( void *  classPtr,
IO::GenericStream stream,
unsigned int  version,
bool  isDataBigEndian 
)
overridevirtual

Load the class data from a stream.

Implements AZ::Serialize::IDataSerializer.

◆ Save()

size_t AZ::AssetSerializer::Save ( const void *  classPtr,
IO::GenericStream stream,
bool  isDataBigEndian = false 
)
overridevirtual

Store the class data into a stream.

Implements AZ::Serialize::IDataSerializer.

◆ TextToData()

size_t AZ::AssetSerializer::TextToData ( const char *  text,
unsigned int  textVersion,
IO::GenericStream stream,
bool  isDataBigEndian 
)
overridevirtual

Convert text data to binary, to support loading old version formats. We must respect text version if the text->binary format has changed!

Implements AZ::Serialize::IDataSerializer.


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