[sdl_omap.git] / docs / man3 / SDL_VideoInfo.3

.TH "SDL_VideoInfo" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_VideoInfo \- Video Target information
.SH "STRUCTURE DEFINITION"
.PP
.nf
\f(CWtypedef struct{
  Uint32 hw_available:1;
  Uint32 wm_available:1;
  Uint32 blit_hw:1;
  Uint32 blit_hw_CC:1;
  Uint32 blit_hw_A:1;
  Uint32 blit_sw:1;
  Uint32 blit_sw_CC:1;
  Uint32 blit_sw_A:1;
  Uint32 blit_fill;
  Uint32 video_mem;
  SDL_PixelFormat *vfmt;
} SDL_VideoInfo;\fR
.fi
.PP
.SH "STRUCTURE DATA"
.TP 20
\fBhw_available\fR
Is it possible to create hardware surfaces?
.TP 20
\fBwm_available\fR
Is there a window manager available
.TP 20
\fBblit_hw\fR
Are hardware to hardware blits accelerated?
.TP 20
\fBblit_hw_CC\fR
Are hardware to hardware colorkey blits accelerated?
.TP 20
\fBblit_hw_A\fR
Are hardware to hardware alpha blits accelerated?
.TP 20
\fBblit_sw\fR
Are software to hardware blits accelerated?
.TP 20
\fBblit_sw_CC\fR
Are software to hardware colorkey blits accelerated?
.TP 20
\fBblit_sw_A\fR
Are software to hardware alpha blits accelerated?
.TP 20
\fBblit_fill\fR
Are color fills accelerated?
.TP 20
\fBvideo_mem\fR
Total amount of video memory in Kilobytes
.TP 20
\fBvfmt\fR
\fIPixel format\fR of the video device
.SH "DESCRIPTION"
.PP
This (read-only) structure is returned by \fI\fBSDL_GetVideoInfo\fP\fR\&. It contains information on either the \&'best\&' available mode (if called before \fI\fBSDL_SetVideoMode\fP\fR) or the current video mode\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_GetVideoInfo\fP\fR
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01
Commit	Line	Data
	1	.TH "SDL_VideoInfo" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
	2	.SH "NAME"
	3	SDL_VideoInfo \- Video Target information
	4	.SH "STRUCTURE DEFINITION"
	5	.PP
	6	.nf
	7	\f(CWtypedef struct{
	8	Uint32 hw_available:1;
	9	Uint32 wm_available:1;
	10	Uint32 blit_hw:1;
	11	Uint32 blit_hw_CC:1;
	12	Uint32 blit_hw_A:1;
	13	Uint32 blit_sw:1;
	14	Uint32 blit_sw_CC:1;
	15	Uint32 blit_sw_A:1;
	16	Uint32 blit_fill;
	17	Uint32 video_mem;
	18	SDL_PixelFormat *vfmt;
	19	} SDL_VideoInfo;\fR
	20	.fi
	21	.PP
	22	.SH "STRUCTURE DATA"
	23	.TP 20
	24	\fBhw_available\fR
	25	Is it possible to create hardware surfaces?
	26	.TP 20
	27	\fBwm_available\fR
	28	Is there a window manager available
	29	.TP 20
	30	\fBblit_hw\fR
	31	Are hardware to hardware blits accelerated?
	32	.TP 20
	33	\fBblit_hw_CC\fR
	34	Are hardware to hardware colorkey blits accelerated?
	35	.TP 20
	36	\fBblit_hw_A\fR
	37	Are hardware to hardware alpha blits accelerated?
	38	.TP 20
	39	\fBblit_sw\fR
	40	Are software to hardware blits accelerated?
	41	.TP 20
	42	\fBblit_sw_CC\fR
	43	Are software to hardware colorkey blits accelerated?
	44	.TP 20
	45	\fBblit_sw_A\fR
	46	Are software to hardware alpha blits accelerated?
	47	.TP 20
	48	\fBblit_fill\fR
	49	Are color fills accelerated?
	50	.TP 20
	51	\fBvideo_mem\fR
	52	Total amount of video memory in Kilobytes
	53	.TP 20
	54	\fBvfmt\fR
	55	\fIPixel format\fR of the video device
	56	.SH "DESCRIPTION"
	57	.PP
	58	This (read-only) structure is returned by \fI\fBSDL_GetVideoInfo\fP\fR\&. It contains information on either the \&'best\&' available mode (if called before \fI\fBSDL_SetVideoMode\fP\fR) or the current video mode\&.
	59	.SH "SEE ALSO"
	60	.PP
	61	\fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_GetVideoInfo\fP\fR
	62	.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01