lib/pods/SDL/VideoInfo.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SDL::VideoInfo - Video Target Information
   6
   7 =head1 SYNOPSIS
   8
   9         my $video_info = SDL::Video::get_video_info();
  10
  11 VideoInfo is only accessible C<SDL::Video::get_video_info>. This module only provides getters to the struct C<SDL_VideoInfo>.
  12
  13
  14 =head1 DESCRIPTION
  15
  16 This object is a read-only structure and is returned by C<SDL::Video::get_video_info>. It contains information on either the best available mode if called before C<SDL::Video::set_video_mode> or the current video mode if called after C<SDL::Video::set_video_mode>.
  17
  18 =head1 METHODS
  19
  20
  21 =head2 hw_available
  22
  23         $video_info->hw_available() # 1 if Hardware Accelerated Surfaces available
  24
  25 Is it possible to create hardware surfaces ?
  26
  27 =head2 wm_available
  28
  29         $video_info->wm_available() # 1 if Window Manager available
  30
  31 Is there a window manager available ?
  32
  33 =head2 blit_hw
  34
  35         $video_info->blit_hw()
  36
  37 Are hardware to hardware blits accelerated ?
  38
  39 =head2 blit_hw_CC
  40
  41         $video_info->blit_hw_CC()
  42
  43 Are hardware to hardware colorkey blits accelerated ?
  44
  45 =head2 blit_hw_A
  46
  47         $video_info->blit_hw_A()
  48
  49 Are hardware to hardware alpha blits accelerated ?
  50
  51 =head2 blit_sw
  52
  53         $video_info->blit_sw()
  54
  55 Are software to hardware blits accelerated ?
  56
  57 =head2 blit_sw_CC
  58
  59         $video_info->blit_sw_CC()
  60
  61
  62 Are software to hardware colorkey blits accelerated ?
  63
  64 =head2 blit_sw_A
  65
  66         $video_info->blit_sw_A()
  67
  68 Are software to hardware alpha blits accelerated ?
  69
  70 =head2 blit_fill
  71
  72         $video_info->blit_fill()
  73
  74 Are color fills accelerated ?
  75
  76 =head2 video_mem
  77
  78         my $video_mem = $video_info->video_mem();
  79
  80 Total amount of video memory in Kilobytes, should be accessed only if hw_available == 1, otherwise it is equal to 0
  81
  82 =head2 vfmt
  83
  84         my $vd_pixel_format = $video_info->vfmt();
  85
  86
  87 C<SDL::PixelFormat> of the video device
  88
  89 =head2 current_w, current_h
  90
  91         $video_info->current_w();
  92         $video_info->current_h();
  93
  94 Width and height of the current video mode, or of the desktop mode if C<SDL_GetVideoInfo> was called before C<SDL::Video::set_video_mode> (available since SDL 1.2.10)
  95
  96 =head1 SEE ALSO
  97
  98 L<SDL::Video>, L<SDL::PixelFormat>
  99
 100 =cut