Contains static methods for converting the byte order between different endiannesses. More...

#include "juce_ByteOrder.h"

Static Public Member Functions
static constexpr uint16	swap (uint16 value) noexcept
	Swaps the upper and lower bytes of a 16-bit integer.

static constexpr int16	swap (int16 value) noexcept
	Swaps the upper and lower bytes of a 16-bit integer.

static uint32	swap (uint32 value) noexcept
	Reverses the order of the 4 bytes in a 32-bit integer.

static int32	swap (int32 value) noexcept
	Reverses the order of the 4 bytes in a 32-bit integer.

static uint64	swap (uint64 value) noexcept
	Reverses the order of the 8 bytes in a 64-bit integer.

static int64	swap (int64 value) noexcept
	Reverses the order of the 8 bytes in a 64-bit integer.

static float	swap (float value) noexcept
	Returns a garbled float which has the reverse byte-order of the original.

static double	swap (double value) noexcept
	Returns a garbled double which has the reverse byte-order of the original.

template<typename Type >
static Type	swapIfBigEndian (Type value) noexcept
	Swaps the byte order of a signed or unsigned integer if the CPU is big-endian.

template<typename Type >
static Type	swapIfLittleEndian (Type value) noexcept
	Swaps the byte order of a signed or unsigned integer if the CPU is little-endian.

static constexpr uint32	littleEndianInt (const void *bytes) noexcept
	Turns 4 bytes into a little-endian integer.

static constexpr uint64	littleEndianInt64 (const void *bytes) noexcept
	Turns 8 bytes into a little-endian integer.

static constexpr uint16	littleEndianShort (const void *bytes) noexcept
	Turns 2 bytes into a little-endian integer.

static constexpr int	littleEndian24Bit (const void *bytes) noexcept
	Converts 3 little-endian bytes into a signed 24-bit value (which is sign-extended to 32 bits).

static void	littleEndian24BitToChars (int32 value, void *destBytes) noexcept
	Copies a 24-bit number to 3 little-endian bytes.

static constexpr uint32	bigEndianInt (const void *bytes) noexcept
	Turns 4 bytes into a big-endian integer.

static constexpr uint64	bigEndianInt64 (const void *bytes) noexcept
	Turns 8 bytes into a big-endian integer.

static constexpr uint16	bigEndianShort (const void *bytes) noexcept
	Turns 2 bytes into a big-endian integer.

static constexpr int	bigEndian24Bit (const void *bytes) noexcept
	Converts 3 big-endian bytes into a signed 24-bit value (which is sign-extended to 32 bits).

static void	bigEndian24BitToChars (int32 value, void *destBytes) noexcept
	Copies a 24-bit number to 3 big-endian bytes.

static constexpr uint16	makeInt (uint8 leastSig, uint8 mostSig) noexcept
	Constructs a 16-bit integer from its constituent bytes, in order of significance.

static constexpr uint32	makeInt (uint8 leastSig, uint8 byte1, uint8 byte2, uint8 mostSig) noexcept
	Constructs a 32-bit integer from its constituent bytes, in order of significance.

static constexpr uint64	makeInt (uint8 leastSig, uint8 byte1, uint8 byte2, uint8 byte3, uint8 byte4, uint8 byte5, uint8 byte6, uint8 mostSig) noexcept
	Constructs a 64-bit integer from its constituent bytes, in order of significance.

static constexpr bool	isBigEndian () noexcept
	Returns true if the current CPU is big-endian.

Detailed Description

Contains static methods for converting the byte order between different endiannesses.

@tags{Core}

Definition at line 32 of file juce_ByteOrder.h.

Member Function Documentation

◆ bigEndian24Bit()

constexpr int32 juce::ByteOrder::bigEndian24Bit ( const void * bytes )

staticconstexprnoexcept

Converts 3 big-endian bytes into a signed 24-bit value (which is sign-extended to 32 bits).

Definition at line 215 of file juce_ByteOrder.h.

◆ bigEndian24BitToChars()

void juce::ByteOrder::bigEndian24BitToChars	(	int32	value,
		void *	destBytes
	)

staticnoexcept

Copies a 24-bit number to 3 big-endian bytes.

Definition at line 218 of file juce_ByteOrder.h.

◆ bigEndianInt()

constexpr uint32 juce::ByteOrder::bigEndianInt ( const void * bytes )

staticconstexprnoexcept

Turns 4 bytes into a big-endian integer.

Definition at line 207 of file juce_ByteOrder.h.

◆ bigEndianInt64()

constexpr uint64 juce::ByteOrder::bigEndianInt64 ( const void * bytes )

staticconstexprnoexcept

Turns 8 bytes into a big-endian integer.

Definition at line 209 of file juce_ByteOrder.h.

◆ bigEndianShort()

constexpr uint16 juce::ByteOrder::bigEndianShort ( const void * bytes )

staticconstexprnoexcept

Turns 2 bytes into a big-endian integer.

Definition at line 206 of file juce_ByteOrder.h.

◆ isBigEndian()

static constexpr bool juce::ByteOrder::isBigEndian ( )

staticconstexprnoexcept

Returns true if the current CPU is big-endian.

Definition at line 128 of file juce_ByteOrder.h.

◆ littleEndian24Bit()

constexpr int32 juce::ByteOrder::littleEndian24Bit ( const void * bytes )

staticconstexprnoexcept

Converts 3 little-endian bytes into a signed 24-bit value (which is sign-extended to 32 bits).

Definition at line 214 of file juce_ByteOrder.h.

◆ littleEndian24BitToChars()

void juce::ByteOrder::littleEndian24BitToChars	(	int32	value,
		void *	destBytes
	)

staticnoexcept

Copies a 24-bit number to 3 little-endian bytes.

Definition at line 217 of file juce_ByteOrder.h.

◆ littleEndianInt()

constexpr uint32 juce::ByteOrder::littleEndianInt ( const void * bytes )

staticconstexprnoexcept

Turns 4 bytes into a little-endian integer.

Definition at line 199 of file juce_ByteOrder.h.

◆ littleEndianInt64()

constexpr uint64 juce::ByteOrder::littleEndianInt64 ( const void * bytes )

staticconstexprnoexcept

Turns 8 bytes into a little-endian integer.

Definition at line 201 of file juce_ByteOrder.h.

◆ littleEndianShort()

constexpr uint16 juce::ByteOrder::littleEndianShort ( const void * bytes )

staticconstexprnoexcept

Turns 2 bytes into a little-endian integer.

Definition at line 198 of file juce_ByteOrder.h.

◆ makeInt() [1/3]

constexpr uint64 juce::ByteOrder::makeInt	(	uint8	leastSig,
		uint8	byte1,
		uint8	byte2,
		uint8	byte3,
		uint8	byte4,
		uint8	byte5,
		uint8	byte6,
		uint8	mostSig
	)

staticconstexprnoexcept

Constructs a 64-bit integer from its constituent bytes, in order of significance.

Definition at line 192 of file juce_ByteOrder.h.

◆ makeInt() [2/3]

constexpr uint32 juce::ByteOrder::makeInt	(	uint8	leastSig,
		uint8	byte1,
		uint8	byte2,
		uint8	mostSig
	)

staticconstexprnoexcept

Constructs a 32-bit integer from its constituent bytes, in order of significance.

Definition at line 186 of file juce_ByteOrder.h.

◆ makeInt() [3/3]

constexpr uint16 juce::ByteOrder::makeInt	(	uint8	leastSig,
		uint8	mostSig
	)

staticconstexprnoexcept

Constructs a 16-bit integer from its constituent bytes, in order of significance.

Definition at line 181 of file juce_ByteOrder.h.

◆ swap() [1/8]

double juce::ByteOrder::swap ( double value )

staticnoexcept

Returns a garbled double which has the reverse byte-order of the original.

Definition at line 148 of file juce_ByteOrder.h.

◆ swap() [2/8]

float juce::ByteOrder::swap ( float value )

staticnoexcept

Returns a garbled float which has the reverse byte-order of the original.

Definition at line 147 of file juce_ByteOrder.h.

◆ swap() [3/8]

constexpr int16 juce::ByteOrder::swap ( int16 value )

staticconstexprnoexcept

Swaps the upper and lower bytes of a 16-bit integer.

Definition at line 144 of file juce_ByteOrder.h.

◆ swap() [4/8]

int32 juce::ByteOrder::swap ( int32 value )

staticnoexcept

Reverses the order of the 4 bytes in a 32-bit integer.

Definition at line 145 of file juce_ByteOrder.h.

◆ swap() [5/8]

int64 juce::ByteOrder::swap ( int64 value )

staticnoexcept

Reverses the order of the 8 bytes in a 64-bit integer.

Definition at line 146 of file juce_ByteOrder.h.

◆ swap() [6/8]

constexpr uint16 juce::ByteOrder::swap ( uint16 value )

staticconstexprnoexcept

Swaps the upper and lower bytes of a 16-bit integer.

Definition at line 143 of file juce_ByteOrder.h.

◆ swap() [7/8]

uint32 juce::ByteOrder::swap ( uint32 value )

staticnoexcept

Reverses the order of the 4 bytes in a 32-bit integer.

Definition at line 154 of file juce_ByteOrder.h.

◆ swap() [8/8]

uint64 juce::ByteOrder::swap ( uint64 value )

staticnoexcept

Reverses the order of the 8 bytes in a 64-bit integer.

Definition at line 170 of file juce_ByteOrder.h.

◆ swapIfBigEndian()

template<typename Type >

static Type juce::ByteOrder::swapIfBigEndian ( Type value )

staticnoexcept

Swaps the byte order of a signed or unsigned integer if the CPU is big-endian.

Definition at line 63 of file juce_ByteOrder.h.

◆ swapIfLittleEndian()

template<typename Type >

static Type juce::ByteOrder::swapIfLittleEndian ( Type value )

staticnoexcept

Swaps the byte order of a signed or unsigned integer if the CPU is little-endian.

Definition at line 74 of file juce_ByteOrder.h.

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

juce_core/memory/juce_ByteOrder.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ bigEndian24Bit()

◆ bigEndian24BitToChars()

◆ bigEndianInt()

◆ bigEndianInt64()

◆ bigEndianShort()

◆ isBigEndian()

◆ littleEndian24Bit()

◆ littleEndian24BitToChars()

◆ littleEndianInt()

◆ littleEndianInt64()

◆ littleEndianShort()

◆ makeInt() [1/3]

◆ makeInt() [2/3]

◆ makeInt() [3/3]

◆ swap() [1/8]

◆ swap() [2/8]

◆ swap() [3/8]

◆ swap() [4/8]

◆ swap() [5/8]

◆ swap() [6/8]

◆ swap() [7/8]

◆ swap() [8/8]

◆ swapIfBigEndian()

◆ swapIfLittleEndian()