SDL 3.0
SDL_cpuinfo.h File Reference

CPU feature detection for SDL. More...

+ Include dependency graph for SDL_cpuinfo.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define SDL_CACHELINE_SIZE   128
 

Functions

int SDL_GetCPUCount (void)
 
int SDL_GetCPUCacheLineSize (void)
 
SDL_bool SDL_HasRDTSC (void)
 
SDL_bool SDL_HasAltiVec (void)
 
SDL_bool SDL_HasMMX (void)
 
SDL_bool SDL_HasSSE (void)
 
SDL_bool SDL_HasSSE2 (void)
 
SDL_bool SDL_HasSSE3 (void)
 
SDL_bool SDL_HasSSE41 (void)
 
SDL_bool SDL_HasSSE42 (void)
 
SDL_bool SDL_HasAVX (void)
 
SDL_bool SDL_HasAVX2 (void)
 
SDL_bool SDL_HasAVX512F (void)
 
SDL_bool SDL_HasARMSIMD (void)
 
SDL_bool SDL_HasNEON (void)
 
SDL_bool SDL_HasLSX (void)
 
SDL_bool SDL_HasLASX (void)
 
int SDL_GetSystemRAM (void)
 
size_t SDL_SIMDGetAlignment (void)
 

Detailed Description

CPU feature detection for SDL.

Definition in file SDL_cpuinfo.h.

Macro Definition Documentation

◆ SDL_CACHELINE_SIZE

#define SDL_CACHELINE_SIZE   128

Definition at line 44 of file SDL_cpuinfo.h.

Function Documentation

◆ SDL_GetCPUCacheLineSize()

int SDL_GetCPUCacheLineSize ( void  )

Determine the L1 cache line size of the CPU.

This is useful for determining multi-threaded structure padding or SIMD prefetch sizes.

Returns
the L1 cache line size of the CPU, in bytes.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetCPUCount()

int SDL_GetCPUCount ( void  )

Get the number of CPU cores available.

Returns
the total number of logical CPU cores. On CPUs that include technologies such as hyperthreading, the number of logical cores may be more than the number of physical cores.
Since
This function is available since SDL 3.0.0.

◆ SDL_GetSystemRAM()

int SDL_GetSystemRAM ( void  )

Get the amount of RAM configured in the system.

Returns
the amount of RAM configured in the system in MiB.
Since
This function is available since SDL 3.0.0.

◆ SDL_HasAltiVec()

SDL_bool SDL_HasAltiVec ( void  )

Determine whether the CPU has AltiVec features.

This always returns false on CPUs that aren't using PowerPC instruction sets.

Returns
SDL_TRUE if the CPU has AltiVec features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAVX
SDL_HasAVX2
SDL_HasMMX
SDL_HasRDTSC
SDL_HasSSE
SDL_HasSSE2
SDL_HasSSE3
SDL_HasSSE41
SDL_HasSSE42

◆ SDL_HasARMSIMD()

SDL_bool SDL_HasARMSIMD ( void  )

Determine whether the CPU has ARM SIMD (ARMv6) features.

This is different from ARM NEON, which is a different instruction set.

This always returns false on CPUs that aren't using ARM instruction sets.

Returns
SDL_TRUE if the CPU has ARM SIMD features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasNEON

◆ SDL_HasAVX()

SDL_bool SDL_HasAVX ( void  )

Determine whether the CPU has AVX features.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has AVX features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAltiVec
SDL_HasAVX2
SDL_HasMMX
SDL_HasRDTSC
SDL_HasSSE
SDL_HasSSE2
SDL_HasSSE3
SDL_HasSSE41
SDL_HasSSE42

◆ SDL_HasAVX2()

SDL_bool SDL_HasAVX2 ( void  )

Determine whether the CPU has AVX2 features.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has AVX2 features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAltiVec
SDL_HasAVX
SDL_HasMMX
SDL_HasRDTSC
SDL_HasSSE
SDL_HasSSE2
SDL_HasSSE3
SDL_HasSSE41
SDL_HasSSE42

◆ SDL_HasAVX512F()

SDL_bool SDL_HasAVX512F ( void  )

Determine whether the CPU has AVX-512F (foundation) features.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has AVX-512F features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAVX

◆ SDL_HasLASX()

SDL_bool SDL_HasLASX ( void  )

Determine whether the CPU has LASX (LOONGARCH SIMD) features.

This always returns false on CPUs that aren't using LOONGARCH instruction sets.

Returns
SDL_TRUE if the CPU has LOONGARCH LASX features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.

◆ SDL_HasLSX()

SDL_bool SDL_HasLSX ( void  )

Determine whether the CPU has LSX (LOONGARCH SIMD) features.

This always returns false on CPUs that aren't using LOONGARCH instruction sets.

Returns
SDL_TRUE if the CPU has LOONGARCH LSX features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.

◆ SDL_HasMMX()

SDL_bool SDL_HasMMX ( void  )

Determine whether the CPU has MMX features.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has MMX features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAltiVec
SDL_HasAVX
SDL_HasAVX2
SDL_HasRDTSC
SDL_HasSSE
SDL_HasSSE2
SDL_HasSSE3
SDL_HasSSE41
SDL_HasSSE42

◆ SDL_HasNEON()

SDL_bool SDL_HasNEON ( void  )

Determine whether the CPU has NEON (ARM SIMD) features.

This always returns false on CPUs that aren't using ARM instruction sets.

Returns
SDL_TRUE if the CPU has ARM NEON features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.

◆ SDL_HasRDTSC()

SDL_bool SDL_HasRDTSC ( void  )

Determine whether the CPU has the RDTSC instruction.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has the RDTSC instruction or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAltiVec
SDL_HasAVX
SDL_HasAVX2
SDL_HasMMX
SDL_HasSSE
SDL_HasSSE2
SDL_HasSSE3
SDL_HasSSE41
SDL_HasSSE42

◆ SDL_HasSSE()

SDL_bool SDL_HasSSE ( void  )

Determine whether the CPU has SSE features.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has SSE features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAltiVec
SDL_HasAVX
SDL_HasAVX2
SDL_HasMMX
SDL_HasRDTSC
SDL_HasSSE2
SDL_HasSSE3
SDL_HasSSE41
SDL_HasSSE42

◆ SDL_HasSSE2()

SDL_bool SDL_HasSSE2 ( void  )

Determine whether the CPU has SSE2 features.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has SSE2 features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAltiVec
SDL_HasAVX
SDL_HasAVX2
SDL_HasMMX
SDL_HasRDTSC
SDL_HasSSE
SDL_HasSSE3
SDL_HasSSE41
SDL_HasSSE42

◆ SDL_HasSSE3()

SDL_bool SDL_HasSSE3 ( void  )

Determine whether the CPU has SSE3 features.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has SSE3 features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAltiVec
SDL_HasAVX
SDL_HasAVX2
SDL_HasMMX
SDL_HasRDTSC
SDL_HasSSE
SDL_HasSSE2
SDL_HasSSE41
SDL_HasSSE42

◆ SDL_HasSSE41()

SDL_bool SDL_HasSSE41 ( void  )

Determine whether the CPU has SSE4.1 features.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has SSE4.1 features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAltiVec
SDL_HasAVX
SDL_HasAVX2
SDL_HasMMX
SDL_HasRDTSC
SDL_HasSSE
SDL_HasSSE2
SDL_HasSSE3
SDL_HasSSE42

◆ SDL_HasSSE42()

SDL_bool SDL_HasSSE42 ( void  )

Determine whether the CPU has SSE4.2 features.

This always returns false on CPUs that aren't using Intel instruction sets.

Returns
SDL_TRUE if the CPU has SSE4.2 features or SDL_FALSE if not.
Since
This function is available since SDL 3.0.0.
See also
SDL_HasAltiVec
SDL_HasAVX
SDL_HasAVX2
SDL_HasMMX
SDL_HasRDTSC
SDL_HasSSE
SDL_HasSSE2
SDL_HasSSE3
SDL_HasSSE41

◆ SDL_SIMDGetAlignment()

size_t SDL_SIMDGetAlignment ( void  )

Report the alignment this system needs for SIMD allocations.

This will return the minimum number of bytes to which a pointer must be aligned to be compatible with SIMD instructions on the current machine. For example, if the machine supports SSE only, it will return 16, but if it supports AVX-512F, it'll return 64 (etc). This only reports values for instruction sets SDL knows about, so if your SDL build doesn't have SDL_HasAVX512F(), then it might return 16 for the SSE support it sees and not 64 for the AVX-512 instructions that exist but SDL doesn't know about. Plan accordingly.

Returns
the alignment in bytes needed for available, known SIMD instructions.
Since
This function is available since SDL 3.0.0.
See also
SDL_aligned_alloc
SDL_aligned_free