.TH "SDLmm::VideoInfo" 3 "16 Jul 2001" "SDLmm" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SDLmm::VideoInfo \- Video target information. 
.SH SYNOPSIS
.br
.PP
\fC#include <sdlmm_videoinfo.h>\fP
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "bool \fBGetVideoInfo\fP ()"
.br
.RI "\fIUpdate the pointer to the video information.\fP"
.ti -1c
.RI "bool \fBhw_available\fP ()"
.br
.RI "\fIReturns true if hardware acceleration is available.\fP"
.ti -1c
.RI "bool \fBwm_available\fP ()"
.br
.RI "\fIReturns true if a window managed is available.\fP"
.ti -1c
.RI "bool \fBblit_hw\fP ()"
.br
.RI "\fIReturns true if hardware to hardware blits are accelerated.\fP"
.ti -1c
.RI "bool \fBblit_hw_CC\fP ()"
.br
.RI "\fIReturns true if hardware to hardware colorkey blits are accelerated.\fP"
.ti -1c
.RI "bool \fBblit_hw_A\fP ()"
.br
.RI "\fIReturns true if hardware to hardware alpha blits are accelerated.\fP"
.ti -1c
.RI "bool \fBblit_sw\fP ()"
.br
.RI "\fIReturns true if software to hardware blits are accelerated.\fP"
.ti -1c
.RI "bool \fBblit_sw_CC\fP ()"
.br
.RI "\fIReturns true if software to hardware colorkey blits are accelerated.\fP"
.ti -1c
.RI "bool \fBblit_sw_A\fP ()"
.br
.RI "\fIReturns true if software to hardware alpha blits are accelerated.\fP"
.ti -1c
.RI "bool \fBblit_fill\fP ()"
.br
.RI "\fIReturns true if color fills are accelerated.\fP"
.ti -1c
.RI "Uint32 \fBvideo_mem\fP ()"
.br
.RI "\fIReturns the total amount of video memory in kilobytes.\fP"
.ti -1c
.RI "const \fBPixelFormat\fP \fBGetPixelFormat\fP () const"
.br
.RI "\fIReturns the SDL_PixelFormat struct for the video device.\fP"
.ti -1c
.RI "\fBPixelFormat\fP \fBGetPixelFormat\fP ()"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "const SDL_VideoInfo* \fBme\fP"
.br
.RI "\fIThe video info struct.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Video target information.
.PP
This object contains read-only information about the video hardware. If this is called before \fBDisplay::SetVideoMode\fP(), the vfmt member of the returned structure will contain the pixel format of the 'best' video mode.
.PP
\fB\fBTodo: \fP\fP
.in +1c
Build a status function allowing for easier access to the flags. This can be done using a bitfield which would allow for checking for multiple features at once. 
.PP
\fBWarning: \fP
.in +1c
Before using information from \fBVideoInfo\fP, the video subsystem must already be initialized. 
.PP
\fBSee also: \fP
.in +1c
\fBDisplay::Init\fP(), \fBDisplay::SetVideoMode\fP() 
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "\fBPixelFormat\fP SDLmm::VideoInfo::GetPixelFormat ()\fC [inline]\fP"
.PP
.SS "const \fBPixelFormat\fP SDLmm::VideoInfo::GetPixelFormat () const\fC [inline]\fP"
.PP
Returns the SDL_PixelFormat struct for the video device.
.PP
.SS "bool SDLmm::VideoInfo::GetVideoInfo ()"
.PP
Update the pointer to the video information.
.PP
\fBReturns: \fP
.in +1c
If the update fails, \fBVideoInfo::me\fP is set to zero and false is returned. true is returned for success.
.PP
\fBNote: \fP
.in +1c
The pointer stored in this object should be updated automatically so there should be no need for the programmer to call this function manually. 
.SS "bool SDLmm::VideoInfo::blit_fill ()"
.PP
Returns true if color fills are accelerated.
.PP
.SS "bool SDLmm::VideoInfo::blit_hw ()"
.PP
Returns true if hardware to hardware blits are accelerated.
.PP
.SS "bool SDLmm::VideoInfo::blit_hw_A ()"
.PP
Returns true if hardware to hardware alpha blits are accelerated.
.PP
.SS "bool SDLmm::VideoInfo::blit_hw_CC ()"
.PP
Returns true if hardware to hardware colorkey blits are accelerated.
.PP
.SS "bool SDLmm::VideoInfo::blit_sw ()"
.PP
Returns true if software to hardware blits are accelerated.
.PP
.SS "bool SDLmm::VideoInfo::blit_sw_A ()"
.PP
Returns true if software to hardware alpha blits are accelerated.
.PP
.SS "bool SDLmm::VideoInfo::blit_sw_CC ()"
.PP
Returns true if software to hardware colorkey blits are accelerated.
.PP
.SS "bool SDLmm::VideoInfo::hw_available ()"
.PP
Returns true if hardware acceleration is available.
.PP
.SS "Uint32 SDLmm::VideoInfo::video_mem ()"
.PP
Returns the total amount of video memory in kilobytes.
.PP
.SS "bool SDLmm::VideoInfo::wm_available ()"
.PP
Returns true if a window managed is available.
.PP
.SH "MEMBER DATA DOCUMENTATION"
.PP 
.SS "const SDL_VideoInfo * SDLmm::VideoInfo::me"
.PP
The video info struct.
.PP
This struct contains the information about the display. You can access it directly or use the \fBVideoInfo\fP functions like \fBVideoInfo::hw_available\fP(). The data stored in this pointer can be updated (if needed) using \fBVideoInfo::GetVideoInfo\fP(). 

.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for SDLmm from the source code.