include/SDL_cpuinfo.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 17 Jan 2011 09:09:15 -0800
changeset 5009 b21ad135d86b
parent 3697 f7b03b6838cb
child 5115 427998ff3bcf
permissions -rw-r--r--
Minor documentation consistency cleanup
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2010 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /**
    24  *  \file SDL_cpuinfo.h
    25  *  
    26  *  CPU feature detection for SDL.
    27  */
    28 
    29 #ifndef _SDL_cpuinfo_h
    30 #define _SDL_cpuinfo_h
    31 
    32 #include "SDL_stdinc.h"
    33 
    34 #include "begin_code.h"
    35 /* Set up for C function definitions, even when using C++ */
    36 #ifdef __cplusplus
    37 /* *INDENT-OFF* */
    38 extern "C" {
    39 /* *INDENT-ON* */
    40 #endif
    41 
    42 /**
    43  *  This function returns the number of CPU cores available.
    44  */
    45 extern DECLSPEC int SDLCALL SDL_GetCPUCount(void);
    46 
    47 /**
    48  *  This function returns true if the CPU has the RDTSC instruction.
    49  */
    50 extern DECLSPEC SDL_bool SDLCALL SDL_HasRDTSC(void);
    51 
    52 /**
    53  *  This function returns true if the CPU has MMX features.
    54  */
    55 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void);
    56 
    57 /**
    58  *  This function returns true if the CPU has MMX Ext.\ features.
    59  */
    60 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMXExt(void);
    61 
    62 /**
    63  *  This function returns true if the CPU has 3DNow!\ features.
    64  */
    65 extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNow(void);
    66 
    67 /**
    68  *  This function returns true if the CPU has 3DNow!\ Ext.\ features.
    69  */
    70 extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNowExt(void);
    71 
    72 /**
    73  *  This function returns true if the CPU has SSE features.
    74  */
    75 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void);
    76 
    77 /**
    78  *  This function returns true if the CPU has SSE2 features.
    79  */
    80 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void);
    81 
    82 /**
    83  *  This function returns true if the CPU has AltiVec features.
    84  */
    85 extern DECLSPEC SDL_bool SDLCALL SDL_HasAltiVec(void);
    86 
    87 /* Ends C function definitions when using C++ */
    88 #ifdef __cplusplus
    89 /* *INDENT-OFF* */
    90 }
    91 /* *INDENT-ON* */
    92 #endif
    93 #include "close_code.h"
    94 
    95 #endif /* _SDL_cpuinfo_h */
    96 
    97 /* vi: set ts=4 sw=4 expandtab: */