comparison include/SDL_cpuinfo.h @ 3407:d3baf5ac4e37

Partial fix for bug #859 Header file update from Ken for improved doxygen output
author Sam Lantinga <slouken@libsdl.org>
date Mon, 19 Oct 2009 13:31:58 +0000
parents 99210400e8b9
children 3427271a2d75
comparison
equal deleted inserted replaced
3406:8ae607392409 3407:d3baf5ac4e37
19 Sam Lantinga 19 Sam Lantinga
20 slouken@libsdl.org 20 slouken@libsdl.org
21 */ 21 */
22 22
23 /** 23 /**
24 * \file SDL_cpuinfo.h 24 * \file SDL_cpuinfo.h
25 * 25 *
26 * CPU feature detection for SDL 26 * CPU feature detection for SDL.
27 */ 27 */
28 28
29 #ifndef _SDL_cpuinfo_h 29 #ifndef _SDL_cpuinfo_h
30 #define _SDL_cpuinfo_h 30 #define _SDL_cpuinfo_h
31 31
37 /* *INDENT-OFF* */ 37 /* *INDENT-OFF* */
38 extern "C" { 38 extern "C" {
39 /* *INDENT-ON* */ 39 /* *INDENT-ON* */
40 #endif 40 #endif
41 41
42 /* This function returns true if the CPU has the RDTSC instruction 42 /**
43 * This function returns true if the CPU has the RDTSC instruction.
43 */ 44 */
44 extern DECLSPEC SDL_bool SDLCALL SDL_HasRDTSC(void); 45 extern DECLSPEC SDL_bool SDLCALL SDL_HasRDTSC(void);
45 46
46 /* This function returns true if the CPU has MMX features 47 /**
48 * This function returns true if the CPU has MMX features.
47 */ 49 */
48 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void); 50 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void);
49 51
50 /* This function returns true if the CPU has MMX Ext. features 52 /**
53 * This function returns true if the CPU has MMX Ext.\ features.
51 */ 54 */
52 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMXExt(void); 55 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMXExt(void);
53 56
54 /* This function returns true if the CPU has 3DNow features 57 /**
58 * This function returns true if the CPU has 3DNow!\ features.
55 */ 59 */
56 extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNow(void); 60 extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNow(void);
57 61
58 /* This function returns true if the CPU has 3DNow! Ext. features 62 /**
63 * This function returns true if the CPU has 3DNow!\ Ext.\ features.
59 */ 64 */
60 extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNowExt(void); 65 extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNowExt(void);
61 66
62 /* This function returns true if the CPU has SSE features 67 /**
68 * This function returns true if the CPU has SSE features.
63 */ 69 */
64 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void); 70 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void);
65 71
66 /* This function returns true if the CPU has SSE2 features 72 /**
73 * This function returns true if the CPU has SSE2 features.
67 */ 74 */
68 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void); 75 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void);
69 76
70 /* This function returns true if the CPU has AltiVec features 77 /**
78 * This function returns true if the CPU has AltiVec features.
71 */ 79 */
72 extern DECLSPEC SDL_bool SDLCALL SDL_HasAltiVec(void); 80 extern DECLSPEC SDL_bool SDLCALL SDL_HasAltiVec(void);
73 81
74 /* Ends C function definitions when using C++ */ 82 /* Ends C function definitions when using C++ */
75 #ifdef __cplusplus 83 #ifdef __cplusplus