sdl3-bindgen-sys
Safe HaskellNone
LanguageGHC2021

SDL3.Sys.Bindgen.EndianShims.FunPtr

Synopsis

Documentation

lithon_SDL_Swap16 :: FunPtr (Uint16 -> IO Uint16) Source #

Byte-swap an unsigned 16-bit number.

The SDL_Swap16 macro as a function. It always byte-swaps the value, whatever the system's byte order; SDL_Swap16LE or SDL_Swap16BE are what you want in most cases.

x
the value to byte-swap.
Returns
x, with its bytes in the opposite endian order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_Swap16, defined at sdl3-bindgen-sys/SDL_endian_shims.h 38:26

Since: 3.2.0

lithon_SDL_Swap32 :: FunPtr (Uint32 -> IO Uint32) Source #

Byte-swap an unsigned 32-bit number.

The SDL_Swap32 macro as a function. It always byte-swaps the value, whatever the system's byte order; SDL_Swap32LE or SDL_Swap32BE are what you want in most cases.

x
the value to byte-swap.
Returns
x, with its bytes in the opposite endian order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_Swap32, defined at sdl3-bindgen-sys/SDL_endian_shims.h 57:26

Since: 3.2.0

lithon_SDL_Swap64 :: FunPtr (Uint64 -> IO Uint64) Source #

Byte-swap an unsigned 64-bit number.

The SDL_Swap64 macro as a function. It always byte-swaps the value, whatever the system's byte order; SDL_Swap64LE or SDL_Swap64BE are what you want in most cases.

x
the value to byte-swap.
Returns
x, with its bytes in the opposite endian order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_Swap64, defined at sdl3-bindgen-sys/SDL_endian_shims.h 76:26

Since: 3.2.0

lithon_SDL_Swap16LE :: FunPtr (Uint16 -> IO Uint16) Source #

Swap a 16-bit value from littleendian to native byte order.

The SDL_Swap16LE macro as a function. If this is running on a littleendian system, x is returned unchanged.

x
the value to swap, in littleendian byte order.
Returns
x in native byte order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_Swap16LE, defined at sdl3-bindgen-sys/SDL_endian_shims.h 94:26

Since: 3.2.0

lithon_SDL_Swap32LE :: FunPtr (Uint32 -> IO Uint32) Source #

Swap a 32-bit value from littleendian to native byte order.

The SDL_Swap32LE macro as a function. If this is running on a littleendian system, x is returned unchanged.

x
the value to swap, in littleendian byte order.
Returns
x in native byte order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_Swap32LE, defined at sdl3-bindgen-sys/SDL_endian_shims.h 112:26

Since: 3.2.0

lithon_SDL_Swap64LE :: FunPtr (Uint64 -> IO Uint64) Source #

Swap a 64-bit value from littleendian to native byte order.

The SDL_Swap64LE macro as a function. If this is running on a littleendian system, x is returned unchanged.

x
the value to swap, in littleendian byte order.
Returns
x in native byte order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_Swap64LE, defined at sdl3-bindgen-sys/SDL_endian_shims.h 130:26

Since: 3.2.0

lithon_SDL_SwapFloatLE :: FunPtr (CFloat -> IO CFloat) Source #

Swap a floating point value from littleendian to native byte order.

The SDL_SwapFloatLE macro as a function. If this is running on a littleendian system, x is returned unchanged.

x
the value to swap, in littleendian byte order.
Returns
x in native byte order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_SwapFloatLE, defined at sdl3-bindgen-sys/SDL_endian_shims.h 148:25

Since: 3.2.0

lithon_SDL_Swap16BE :: FunPtr (Uint16 -> IO Uint16) Source #

Swap a 16-bit value from bigendian to native byte order.

The SDL_Swap16BE macro as a function. If this is running on a bigendian system, x is returned unchanged.

x
the value to swap, in bigendian byte order.
Returns
x in native byte order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_Swap16BE, defined at sdl3-bindgen-sys/SDL_endian_shims.h 166:26

Since: 3.2.0

lithon_SDL_Swap32BE :: FunPtr (Uint32 -> IO Uint32) Source #

Swap a 32-bit value from bigendian to native byte order.

The SDL_Swap32BE macro as a function. If this is running on a bigendian system, x is returned unchanged.

x
the value to swap, in bigendian byte order.
Returns
x in native byte order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_Swap32BE, defined at sdl3-bindgen-sys/SDL_endian_shims.h 184:26

Since: 3.2.0

lithon_SDL_Swap64BE :: FunPtr (Uint64 -> IO Uint64) Source #

Swap a 64-bit value from bigendian to native byte order.

The SDL_Swap64BE macro as a function. If this is running on a bigendian system, x is returned unchanged.

x
the value to swap, in bigendian byte order.
Returns
x in native byte order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_Swap64BE, defined at sdl3-bindgen-sys/SDL_endian_shims.h 202:26

Since: 3.2.0

lithon_SDL_SwapFloatBE :: FunPtr (CFloat -> IO CFloat) Source #

Swap a floating point value from bigendian to native byte order.

The SDL_SwapFloatBE macro as a function. If this is running on a bigendian system, x is returned unchanged.

x
the value to swap, in bigendian byte order.
Returns
x in native byte order.
Thread safety
It is safe to call this function from any thread.
C declaration
lithon_SDL_SwapFloatBE, defined at sdl3-bindgen-sys/SDL_endian_shims.h 220:25

Since: 3.2.0