Open 3D Engine EMotionFX 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.
|
#include <Endian.h>
Public Types | |
enum | EEndianType { ENDIAN_LITTLE = 0 , ENDIAN_BIG = 1 } |
Static Public Member Functions | |
static MCORE_INLINE void | ConvertUnsignedInt16 (uint16 *value, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt32 (uint32 *value, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt64 (uint64 *value, uint32 count=1) |
static MCORE_INLINE void | ConvertSignedInt16 (int16 *value, uint32 count=1) |
static MCORE_INLINE void | ConvertSignedInt32 (int32 *value, uint32 count=1) |
static MCORE_INLINE void | ConvertFloat (float *value, uint32 count=1) |
static MCORE_INLINE void | ConvertVector2 (AZ::Vector2 *value, uint32 count=1) |
static MCORE_INLINE void | ConvertVector3 (AZ::Vector3 *value, uint32 count=1) |
static MCORE_INLINE void | ConvertVector4 (AZ::Vector4 *value, uint32 count=1) |
static MCORE_INLINE void | ConvertQuaternion (AZ::Quaternion *value, uint32 count=1) |
static MCORE_INLINE void | Convert16BitQuaternion (MCore::Compressed16BitQuaternion *value, uint32 count=1) |
static MCORE_INLINE void | SwapBytes (uint8 *byteA, uint8 *byteB) |
static MCORE_INLINE void | ConvertEndian16 (uint8 *buffer, uint32 count=1) |
static MCORE_INLINE void | ConvertEndian32 (uint8 *buffer, uint32 count=1) |
static MCORE_INLINE void | ConvertEndian64 (uint8 *buffer, uint32 count=1) |
static MCORE_INLINE void | ConvertFloat (float *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertSignedInt32 (int32 *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt32 (uint32 *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt64 (uint64 *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertSignedInt16 (int16 *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt16 (uint16 *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertVector2 (AZ::Vector2 *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertVector3 (AZ::Vector3 *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertVector4 (AZ::Vector4 *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertQuaternion (AZ::Quaternion *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | Convert16BitQuaternion (MCore::Compressed16BitQuaternion *value, EEndianType sourceEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertFloat (float *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertSignedInt32 (int32 *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt32 (uint32 *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt64 (uint64 *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertSignedInt16 (int16 *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt16 (uint16 *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertVector2 (AZ::Vector2 *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertVector3 (AZ::Vector3 *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertVector4 (AZ::Vector4 *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertQuaternion (AZ::Quaternion *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | Convert16BitQuaternion (MCore::Compressed16BitQuaternion *value, EEndianType sourceEndianType, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertFloatTo (float *value, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertSignedInt32To (int32 *value, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt32To (uint32 *value, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertSignedInt16To (int16 *value, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertUnsignedInt16To (uint16 *value, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertVector2To (AZ::Vector2 *value, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertVector3To (AZ::Vector3 *value, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertVector4To (AZ::Vector4 *value, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | ConvertQuaternionTo (AZ::Quaternion *value, EEndianType targetEndianType, uint32 count=1) |
static MCORE_INLINE void | Convert16BitQuaternionTo (MCore::Compressed16BitQuaternion *value, EEndianType targetEndianType, uint32 count=1) |
The endian class is a collection of static functions that allow you to convert specific object types into another endian conversion. This is useful when loading files from disk, which are stored in another endian than the platform you are running your code on.
|
static |
Convert a 16-bit compressed Quaternion object into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a 16-bit compressed Quaternion object into the endian used by our current platform.
value | The object to convert the endian for. |
sourceEndianType | The endian type where the object is currently stored in. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Swap the endian of one or more 16-bit compressed Quaternion objects.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert a 16-bit compressed Quaternion object into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Switches the endian (little or big) of a set of 16 bit values. This means the byte order gets inverted. A byte order of (B1 B2) gets converted into (B2 B1).
buffer | The input buffer that points to the data containing the values to be converted. |
count | The number of 16 bit values to convert. |
|
static |
Switches the endian (little or big) of a set of 32 bit values. This means the byte order gets inverted. A byte order of (B1 B2 B3 B4) gets converted into (B4 B3 B2 B1).
buffer | The input buffer that points to the data containing the values to be converted. |
count | The number of 32 bit values to convert. |
|
static |
Switches the endian (little or big) of a set of 64 bit values. This means the byte order gets inverted. A byte order of (B1 B2 B3 B4 B5 B6 B7 B8) gets converted into (B8 B7 B6 B5 B4 B3 B2 B1).
buffer | The input buffer that points to the data containing the values to be converted. |
count | The number of 64 bit values to convert. |
|
static |
Convert a floating point value into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert one or more 32 bit floating point values into the endian used by our current platform.
value | The value(s) to convert. The number of values to follow at the specified address must be at least the number that you pass to the count parameter. |
sourceEndianType | The endian type where the float is currently stored in. |
count | The number of floats to convert. |
|
static |
Swap the endian of one or more floats.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert a floating point value into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a Quaternion object into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a Quaternion object into the endian used by our current platform.
value | The object to convert the endian for. |
sourceEndianType | The endian type where the object is currently stored in. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Swap the endian of one or more Quaternion objects.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert a Quaternion object into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert an 16 bit short into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert one or more 16 bit short values into the endian used by our current platform.
value | The value(s) to convert. The number of values to follow at the specified address must be at least the number that you pass to the count parameter. |
sourceEndianType | The endian type where the short is currently stored in. |
count | The number of shorts to convert. |
|
static |
Swap the endian of one or more shorts.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert an 16 bit short into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a 32 bit int32 into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert one or more 32 bit integer values into the endian used by our current platform.
value | The value(s) to convert. The number of values to follow at the specified address must be at least the number that you pass to the count parameter. |
sourceEndianType | The endian type where the int32 is currently stored in. |
count | The number of integers to convert. |
|
static |
Swap the endian of one or more ints.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert a 32 bit int32 into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert an unsigned 16 bit short into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert one or more 16 bit uint16 values into the endian used by our current platform.
value | The value(s) to convert. The number of values to follow at the specified address must be at least the number that you pass to the count parameter. |
sourceEndianType | The endian type where the short is currently stored in. |
count | The number of shorts to convert. |
|
static |
Swap the endian of one or more unsigned shorts.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert an unsigned 16 bit short into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a 32 bit uint32 into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert one or more 32 bit unsigned integer values into the endian used by our current platform.
value | The value(s) to convert. The number of values to follow at the specified address must be at least the number that you pass to the count parameter. |
sourceEndianType | The endian type where the int32 is currently stored in. |
count | The number of integers to convert. |
|
static |
Swap the endian of one or more unsigned ints.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert a 32 bit uint32 into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a Vector2 object into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a Vector2 object into the endian used by our current platform.
value | The object to convert the endian for. |
sourceEndianType | The endian type where the object is currently stored in. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Swap the endian of one or more Vector2 objects.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert a Vector2 object into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a Vector3 object into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a PackedVector3f object into the endian used by our current platform.
value | The object to convert the endian for. |
sourceEndianType | The endian type where the object is currently stored in. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Swap the endian of one or more PackedVector3f objects.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert a Vector3 object into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a Vector4 object into another endian type.
value | A pointer to the object to convert/modify. |
sourceEndianType | The endian type where the value is currently stored in, before conversion. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Convert a Vector4 object into the endian used by our current platform.
value | The object to convert the endian for. |
sourceEndianType | The endian type where the object is currently stored in. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Swap the endian of one or more Vector4 objects.
value | The value to convert the endian for. |
count | The number of items to convert. Please note that the array specified by value must be large enough! |
|
static |
Convert a Vector4 object into another endian type.
value | A pointer to the object to convert/modify. |
targetEndianType | The endian type that the value should be converted into. |
count | The number of objects to convert. This allows conversion of arrays at once. |
|
static |
Swap two bytes values. This means that after executing this method, the memory address of byteA will contain the value of the byte stored at memory address byteB, and the other way around.
byteA | The memory address of byte number one. |
byteB | The memory address of byte number two. |