---
name: "SDLmm_VideoInfo"
section: "3"
platform: "linux"
package: "libsdl-mm0.1"
version: "0.1.8-4"
release: "Debian 3.0 (Woody)"
platforms: ["linux"]
url: "https://new.carta.tech/SDLmm_VideoInfo"
---

# SDLmm\_VideoInfo(3)

Video target information.

## NAME

SDLmm::VideoInfo - Video target information.

## 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.**