GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SDLMM_VIDEOINFO (3)

NAME

SDLmm::VideoInfo - Video target information.

CONTENTS

Synopsis

SYNOPSIS

#include <sdlmm_videoinfo.h>

    Public Methods

    bool GetVideoInfo ()
Update the pointer to the video information.     bool hw_available ()
Returns true if hardware acceleration is available.     bool wm_available ()
Returns true if a window managed is available.     bool blit_hw ()
Returns true if hardware to hardware blits are accelerated.     bool blit_hw_CC ()
Returns true if hardware to hardware colorkey blits are accelerated.     bool blit_hw_A ()
Returns true if hardware to hardware alpha blits are accelerated.     bool blit_sw ()
Returns true if software to hardware blits are accelerated.     bool blit_sw_CC ()
Returns true if software to hardware colorkey blits are accelerated.     bool blit_sw_A ()
Returns true if software to hardware alpha blits are accelerated.     bool blit_fill ()
Returns true if color fills are accelerated.     Uint32 video_mem ()
Returns the total amount of video memory in kilobytes.     const PixelFormat GetPixelFormat () const
Returns the SDL_PixelFormat struct for the video device.     PixelFormat GetPixelFormat ()

    Public Attributes

    const SDL_VideoInfo* me
The video info struct.

DETAILED DESCRIPTION

Video target information.

This object contains read-only information about the video hardware. If this is called before Display::SetVideoMode(), the vfmt member of the returned structure will contain the pixel format of the ’best’ video mode.

Todo: 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.

Warning: Before using information from VideoInfo, the video subsystem must already be initialized.

See also: Display::Init(), Display::SetVideoMode()

MEMBER FUNCTION DOCUMENTATION

PixelFormat SDLmm::VideoInfo::GetPixelFormat () [inline]

const PixelFormat SDLmm::VideoInfo::GetPixelFormat () const [inline]

Returns the SDL_PixelFormat struct for the video device.

    bool SDLmm::VideoInfo::GetVideoInfo ()

Update the pointer to the video information.

Returns: If the update fails, VideoInfo::me is set to zero and false is returned. true is returned for success.

Note: The pointer stored in this object should be updated automatically so there should be no need for the programmer to call this function manually.

    bool SDLmm::VideoInfo::blit_fill ()

Returns true if color fills are accelerated.

    bool SDLmm::VideoInfo::blit_hw ()

Returns true if hardware to hardware blits are accelerated.

    bool SDLmm::VideoInfo::blit_hw_A ()

Returns true if hardware to hardware alpha blits are accelerated.

    bool SDLmm::VideoInfo::blit_hw_CC ()

Returns true if hardware to hardware colorkey blits are accelerated.

    bool SDLmm::VideoInfo::blit_sw ()

Returns true if software to hardware blits are accelerated.

    bool SDLmm::VideoInfo::blit_sw_A ()

Returns true if software to hardware alpha blits are accelerated.

    bool SDLmm::VideoInfo::blit_sw_CC ()

Returns true if software to hardware colorkey blits are accelerated.

    bool SDLmm::VideoInfo::hw_available ()

Returns true if hardware acceleration is available.

    Uint32 SDLmm::VideoInfo::video_mem ()

Returns the total amount of video memory in kilobytes.

    bool SDLmm::VideoInfo::wm_available ()

Returns true if a window managed is available.

MEMBER DATA DOCUMENTATION

    const SDL_VideoInfo * SDLmm::VideoInfo::me

The video info struct.

This struct contains the information about the display. You can access it directly or use the VideoInfo functions like VideoInfo::hw_available(). The data stored in this pointer can be updated (if needed) using VideoInfo::GetVideoInfo().

AUTHOR

Generated automatically by Doxygen for SDLmm from the source code.

Search for    or go to Top of page |  Section 3 |  Main Index


SDLmm SDLMM::VIDEOINFO (3) 16 Jul 2001

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.