[sdl_omap.git] / docs / html / sdlglgetattribute.html

<HTML
><HEAD
><TITLE
>SDL_GL_GetAttribute</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Video"
HREF="video.html"><LINK
REL="PREVIOUS"
TITLE="SDL_GL_GetProcAddress"
HREF="sdlglgetprocaddress.html"><LINK
REL="NEXT"
TITLE="SDL_GL_SetAttribute"
HREF="sdlglsetattribute.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlglgetprocaddress.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlglsetattribute.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLGLGETATTRIBUTE"
></A
>SDL_GL_GetAttribute</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2708"
></A
><H2
>Name</H2
>SDL_GL_GetAttribute&nbsp;--&nbsp;Get the value of a special SDL/OpenGL attribute</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2711"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN2712"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="FSFUNC"
>SDL_GL_GetAttribute</B
></CODE
>(SDLGLattr attr, int *value);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2718"
></A
><H2
>Description</H2
><P
>Places the value of the SDL/OpenGL <A
HREF="sdlglattr.html"
>attribute</A
> <TT
CLASS="PARAMETER"
><I
>attr</I
></TT
> into <TT
CLASS="PARAMETER"
><I
>value</I
></TT
>. This is useful after a call to <A
HREF="sdlsetvideomode.html"
><TT
CLASS="FUNCTION"
>SDL_SetVideoMode</TT
></A
> to check whether your attributes have been <A
HREF="sdlglsetattribute.html"
>set</A
> as you expected.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2727"
></A
><H2
>Return Value</H2
><P
>Returns <SPAN
CLASS="RETURNVALUE"
>0</SPAN
> on success, or <SPAN
CLASS="RETURNVALUE"
>-1</SPAN
> on an error.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2732"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlglsetattribute.html"
><TT
CLASS="FUNCTION"
>SDL_GL_SetAttribute</TT
></A
>,
<A
HREF="sdlglattr.html"
>GL Attributes</A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlglgetprocaddress.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlglsetattribute.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_GL_GetProcAddress</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="video.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_GL_SetAttribute</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_GL_GetAttribute</TITLE
	5	><META
	6	NAME="GENERATOR"
	7	CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
	8	"><LINK
	9	REL="HOME"
	10	TITLE="SDL Library Documentation"
	11	HREF="index.html"><LINK
	12	REL="UP"
	13	TITLE="Video"
	14	HREF="video.html"><LINK
	15	REL="PREVIOUS"
	16	TITLE="SDL_GL_GetProcAddress"
	17	HREF="sdlglgetprocaddress.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_GL_SetAttribute"
	20	HREF="sdlglsetattribute.html"></HEAD
	21	><BODY
	22	CLASS="REFENTRY"
	23	BGCOLOR="#FFF8DC"
	24	TEXT="#000000"
	25	LINK="#0000ee"
	26	VLINK="#551a8b"
	27	ALINK="#ff0000"
	28	><DIV
	29	CLASS="NAVHEADER"
	30	><TABLE
	31	SUMMARY="Header navigation table"
	32	WIDTH="100%"
	33	BORDER="0"
	34	CELLPADDING="0"
	35	CELLSPACING="0"
	36	><TR
	37	><TH
	38	COLSPAN="3"
	39	ALIGN="center"
	40	>SDL Library Documentation</TH
	41	></TR
	42	><TR
	43	><TD
	44	WIDTH="10%"
	45	ALIGN="left"
	46	VALIGN="bottom"
	47	><A
	48	HREF="sdlglgetprocaddress.html"
	49	ACCESSKEY="P"
	50	>Prev</A
	51	></TD
	52	><TD
	53	WIDTH="80%"
	54	ALIGN="center"
	55	VALIGN="bottom"
	56	></TD
	57	><TD
	58	WIDTH="10%"
	59	ALIGN="right"
	60	VALIGN="bottom"
	61	><A
	62	HREF="sdlglsetattribute.html"
	63	ACCESSKEY="N"
	64	>Next</A
65	></TD
66	></TR
67	></TABLE
68	><HR
69	ALIGN="LEFT"
70	WIDTH="100%"></DIV
71	><H1
72	><A
73	NAME="SDLGLGETATTRIBUTE"
74	></A
75	>SDL_GL_GetAttribute</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN2708"
80	></A
81	><H2
82	>Name</H2
83	>SDL_GL_GetAttribute -- Get the value of a special SDL/OpenGL attribute</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN2711"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN2712"
95	></A
96	><P
97	></P
98	><PRE
99	CLASS="FUNCSYNOPSISINFO"
100	>#include "SDL.h"</PRE
101	><P
102	><CODE
103	><CODE
104	CLASS="FUNCDEF"
105	>int <B
106	CLASS="FSFUNC"
107	>SDL_GL_GetAttribute</B
108	></CODE
109	>(SDLGLattr attr, int *value);</CODE
110	></P
111	><P
112	></P
113	></DIV
114	></DIV
115	><DIV
116	CLASS="REFSECT1"
117	><A
118	NAME="AEN2718"
119	></A
120	><H2
121	>Description</H2
122	><P
123	>Places the value of the SDL/OpenGL <A
124	HREF="sdlglattr.html"
125	>attribute</A
126	> <TT
127	CLASS="PARAMETER"
128	><I
129	>attr</I
130	></TT
131	> into <TT
132	CLASS="PARAMETER"
133	><I
134	>value</I
135	></TT
136	>. This is useful after a call to <A
137	HREF="sdlsetvideomode.html"
138	><TT
139	CLASS="FUNCTION"
140	>SDL_SetVideoMode</TT
141	></A
142	> to check whether your attributes have been <A
143	HREF="sdlglsetattribute.html"
144	>set</A
145	> as you expected.</P
146	></DIV
147	><DIV
148	CLASS="REFSECT1"
149	><A
150	NAME="AEN2727"
151	></A
152	><H2
153	>Return Value</H2
154	><P
155	>Returns <SPAN
156	CLASS="RETURNVALUE"
157	>0</SPAN
158	> on success, or <SPAN
159	CLASS="RETURNVALUE"
160	>-1</SPAN
161	> on an error.</P
162	></DIV
163	><DIV
164	CLASS="REFSECT1"
165	><A
166	NAME="AEN2732"
167	></A
168	><H2
169	>See Also</H2
170	><P
171	><A
172	HREF="sdlglsetattribute.html"
173	><TT
174	CLASS="FUNCTION"
175	>SDL_GL_SetAttribute</TT
176	></A
177	>,
178	<A
179	HREF="sdlglattr.html"
180	>GL Attributes</A
181	></P
182	></DIV
183	><DIV
184	CLASS="NAVFOOTER"
185	><HR
186	ALIGN="LEFT"
187	WIDTH="100%"><TABLE
188	SUMMARY="Footer navigation table"
189	WIDTH="100%"
190	BORDER="0"
191	CELLPADDING="0"
192	CELLSPACING="0"
193	><TR
194	><TD
195	WIDTH="33%"
196	ALIGN="left"
197	VALIGN="top"
198	><A
199	HREF="sdlglgetprocaddress.html"
200	ACCESSKEY="P"
201	>Prev</A
202	></TD
203	><TD
204	WIDTH="34%"
205	ALIGN="center"
206	VALIGN="top"
207	><A
208	HREF="index.html"
209	ACCESSKEY="H"
210	>Home</A
211	></TD
212	><TD
213	WIDTH="33%"
214	ALIGN="right"
215	VALIGN="top"
216	><A
217	HREF="sdlglsetattribute.html"
218	ACCESSKEY="N"
219	>Next</A
220	></TD
221	></TR
222	><TR
223	><TD
224	WIDTH="33%"
225	ALIGN="left"
226	VALIGN="top"
227	>SDL_GL_GetProcAddress</TD
228	><TD
229	WIDTH="34%"
230	ALIGN="center"
231	VALIGN="top"
232	><A
233	HREF="video.html"
234	ACCESSKEY="U"
235	>Up</A
236	></TD
237	><TD
238	WIDTH="33%"
239	ALIGN="right"
240	VALIGN="top"
241	>SDL_GL_SetAttribute</TD
242	></TR
243	></TABLE
244	></DIV
245	></BODY
246	></HTML
247	>