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

<HTML
><HEAD
><TITLE
>SDL_VideoDriverName</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_GetVideoInfo"
HREF="sdlgetvideoinfo.html"><LINK
REL="NEXT"
TITLE="SDL_ListModes"
HREF="sdllistmodes.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="sdlgetvideoinfo.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdllistmodes.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLVIDEODRIVERNAME"
></A
>SDL_VideoDriverName</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1127"
></A
><H2
>Name</H2
>SDL_VideoDriverName&nbsp;--&nbsp;Obtain the name of the video driver</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1130"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN1131"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>char *<B
CLASS="FSFUNC"
>SDL_VideoDriverName</B
></CODE
>(char *namebuf, int maxlen);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1137"
></A
><H2
>Description</H2
><P
>The buffer pointed to by <TT
CLASS="PARAMETER"
><I
>namebuf</I
></TT
> is filled up to a maximum of <TT
CLASS="PARAMETER"
><I
>maxlen</I
></TT
> characters (include the NULL terminator) with the name of the initialised video driver. The driver name is a simple one word identifier like "x11" or "windib".</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1142"
></A
><H2
>Return Value</H2
><P
>Returns <TT
CLASS="LITERAL"
>NULL</TT
> if video has not been initialised with <TT
CLASS="FUNCTION"
>SDL_Init</TT
> or a pointer to <TT
CLASS="PARAMETER"
><I
>namebuf</I
></TT
> otherwise.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1148"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlinit.html"
><TT
CLASS="FUNCTION"
>SDL_Init</TT
></A
>
<A
HREF="sdlinitsubsystem.html"
><TT
CLASS="FUNCTION"
>SDL_InitSubSystem</TT
></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="sdlgetvideoinfo.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="sdllistmodes.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_GetVideoInfo</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_ListModes</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_VideoDriverName</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_GetVideoInfo"
	17	HREF="sdlgetvideoinfo.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_ListModes"
	20	HREF="sdllistmodes.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="sdlgetvideoinfo.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="sdllistmodes.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="SDLVIDEODRIVERNAME"
74	></A
75	>SDL_VideoDriverName</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN1127"
80	></A
81	><H2
82	>Name</H2
83	>SDL_VideoDriverName -- Obtain the name of the video driver</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN1130"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN1131"
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	>char *<B
106	CLASS="FSFUNC"
107	>SDL_VideoDriverName</B
108	></CODE
109	>(char *namebuf, int maxlen);</CODE
110	></P
111	><P
112	></P
113	></DIV
114	></DIV
115	><DIV
116	CLASS="REFSECT1"
117	><A
118	NAME="AEN1137"
119	></A
120	><H2
121	>Description</H2
122	><P
123	>The buffer pointed to by <TT
124	CLASS="PARAMETER"
125	><I
126	>namebuf</I
127	></TT
128	> is filled up to a maximum of <TT
129	CLASS="PARAMETER"
130	><I
131	>maxlen</I
132	></TT
133	> characters (include the NULL terminator) with the name of the initialised video driver. The driver name is a simple one word identifier like "x11" or "windib".</P
134	></DIV
135	><DIV
136	CLASS="REFSECT1"
137	><A
138	NAME="AEN1142"
139	></A
140	><H2
141	>Return Value</H2
142	><P
143	>Returns <TT
144	CLASS="LITERAL"
145	>NULL</TT
146	> if video has not been initialised with <TT
147	CLASS="FUNCTION"
148	>SDL_Init</TT
149	> or a pointer to <TT
150	CLASS="PARAMETER"
151	><I
152	>namebuf</I
153	></TT
154	> otherwise.</P
155	></DIV
156	><DIV
157	CLASS="REFSECT1"
158	><A
159	NAME="AEN1148"
160	></A
161	><H2
162	>See Also</H2
163	><P
164	><A
165	HREF="sdlinit.html"
166	><TT
167	CLASS="FUNCTION"
168	>SDL_Init</TT
169	></A
170	>
171	<A
172	HREF="sdlinitsubsystem.html"
173	><TT
174	CLASS="FUNCTION"
175	>SDL_InitSubSystem</TT
176	></A
177	></P
178	></DIV
179	><DIV
180	CLASS="NAVFOOTER"
181	><HR
182	ALIGN="LEFT"
183	WIDTH="100%"><TABLE
184	SUMMARY="Footer navigation table"
185	WIDTH="100%"
186	BORDER="0"
187	CELLPADDING="0"
188	CELLSPACING="0"
189	><TR
190	><TD
191	WIDTH="33%"
192	ALIGN="left"
193	VALIGN="top"
194	><A
195	HREF="sdlgetvideoinfo.html"
196	ACCESSKEY="P"
197	>Prev</A
198	></TD
199	><TD
200	WIDTH="34%"
201	ALIGN="center"
202	VALIGN="top"
203	><A
204	HREF="index.html"
205	ACCESSKEY="H"
206	>Home</A
207	></TD
208	><TD
209	WIDTH="33%"
210	ALIGN="right"
211	VALIGN="top"
212	><A
213	HREF="sdllistmodes.html"
214	ACCESSKEY="N"
215	>Next</A
216	></TD
217	></TR
218	><TR
219	><TD
220	WIDTH="33%"
221	ALIGN="left"
222	VALIGN="top"
223	>SDL_GetVideoInfo</TD
224	><TD
225	WIDTH="34%"
226	ALIGN="center"
227	VALIGN="top"
228	><A
229	HREF="video.html"
230	ACCESSKEY="U"
231	>Up</A
232	></TD
233	><TD
234	WIDTH="33%"
235	ALIGN="right"
236	VALIGN="top"
237	>SDL_ListModes</TD
238	></TR
239	></TABLE
240	></DIV
241	></BODY
242	></HTML
243	>