pages/SDL-VideoInfo.html-inc

   1 <div class="pod">
   2 <!-- INDEX START -->
   3 <h3 id="TOP">Index</h3>
   4
   5 <ul><li><a href="#NAME">NAME</a>
   6 <ul><li><a href="#CATEGORY">CATEGORY</a></li>
   7 </ul>
   8 </li>
   9 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
  10 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
  11 <li><a href="#METHODS">METHODS</a>
  12 <ul><li><a href="#hw_available">hw_available</a></li>
  13 <li><a href="#wm_available">wm_available</a></li>
  14 <li><a href="#blit_hw">blit_hw</a></li>
  15 <li><a href="#blit_hw_CC">blit_hw_CC</a></li>
  16 <li><a href="#blit_hw_A">blit_hw_A</a></li>
  17 <li><a href="#blit_sw">blit_sw</a></li>
  18 <li><a href="#blit_sw_CC">blit_sw_CC</a></li>
  19 <li><a href="#blit_sw_A">blit_sw_A      </a></li>
  20 <li><a href="#blit_fill">blit_fill</a></li>
  21 <li><a href="#video_mem">video_mem</a></li>
  22 <li><a href="#vfmt">vfmt</a></li>
  23 <li><a href="#current_w_current_h">current_w, current_h</a></li>
  24 </ul>
  25 </li>
  26 <li><a href="#SEE_ALSO">SEE ALSO</a></li>
  27 <li><a href="#AUTHORS">AUTHORS</a>
  28 </li>
  29 </ul><hr />
  30 <!-- INDEX END -->
  31
  32 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
  33 <div id="NAME_CONTENT">
  34 <p>SDL::VideoInfo - Video Target Information </p>
  35
  36 </div>
  37 <h2 id="CATEGORY">CATEGORY</h2>
  38 <div id="CATEGORY_CONTENT">
  39 <p>Core, Video, Structure</p>
  40
  41 </div>
  42 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  43 <div id="SYNOPSIS_CONTENT">
  44 <pre>   my $video_info = SDL::Video::get_video_info();
  45
  46 </pre>
  47 <p>VideoInfo is only accessible <code>SDL::Video::get_video_info</code>. This module only provides getters to the struct <code>SDL_VideoInfo</code>.</p>
  48
  49
  50
  51
  52
  53 </div>
  54 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
  55 <div id="DESCRIPTION_CONTENT">
  56 <p>This object is a read-only structure and is returned by <code>SDL::Video::get_video_info</code>. It contains information on either the best available mode if called before <code>SDL::Video::set_video_mode</code> or the current video mode if called after <code>SDL::Video::set_video_mode</code>. </p>
  57
  58 </div>
  59 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  60 <div id="METHODS_CONTENT">
  61
  62
  63
  64
  65
  66 </div>
  67 <h2 id="hw_available">hw_available</h2>
  68 <div id="hw_available_CONTENT">
  69 <pre>   $video_info-&gt;hw_available() # 1 if Hardware Accelerated Surfaces available
  70
  71 </pre>
  72 <p>Is it possible to create hardware surfaces ?</p>
  73
  74 </div>
  75 <h2 id="wm_available">wm_available</h2>
  76 <div id="wm_available_CONTENT">
  77 <pre>   $video_info-&gt;wm_available() # 1 if Window Manager available
  78
  79 </pre>
  80 <p>Is there a window manager available ?</p>
  81
  82 </div>
  83 <h2 id="blit_hw">blit_hw</h2>
  84 <div id="blit_hw_CONTENT">
  85 <pre>   $video_info-&gt;blit_hw()
  86
  87 </pre>
  88 <p>Are hardware to hardware blits accelerated ?</p>
  89
  90 </div>
  91 <h2 id="blit_hw_CC">blit_hw_CC</h2>
  92 <div id="blit_hw_CC_CONTENT">
  93 <pre>   $video_info-&gt;blit_hw_CC()
  94
  95 </pre>
  96 <p>Are hardware to hardware colorkey blits accelerated ?</p>
  97
  98 </div>
  99 <h2 id="blit_hw_A">blit_hw_A</h2>
 100 <div id="blit_hw_A_CONTENT">
 101 <pre>   $video_info-&gt;blit_hw_A()
 102
 103 </pre>
 104 <p>Are hardware to hardware alpha blits accelerated ?</p>
 105
 106 </div>
 107 <h2 id="blit_sw">blit_sw</h2>
 108 <div id="blit_sw_CONTENT">
 109 <pre>   $video_info-&gt;blit_sw()
 110
 111 </pre>
 112 <p>Are software to hardware blits accelerated ?</p>
 113
 114 </div>
 115 <h2 id="blit_sw_CC">blit_sw_CC</h2>
 116 <div id="blit_sw_CC_CONTENT">
 117 <pre>   $video_info-&gt;blit_sw_CC()
 118
 119
 120
 121
 122 </pre>
 123 <p>Are software to hardware colorkey blits accelerated ?</p>
 124
 125 </div>
 126 <h2 id="blit_sw_A">blit_sw_A    </h2>
 127 <div id="blit_sw_A_CONTENT">
 128 <pre>   $video_info-&gt;blit_sw_A()
 129
 130 </pre>
 131 <p>Are software to hardware alpha blits accelerated ?</p>
 132
 133 </div>
 134 <h2 id="blit_fill">blit_fill</h2>
 135 <div id="blit_fill_CONTENT">
 136 <pre>   $video_info-&gt;blit_fill()
 137
 138 </pre>
 139 <p>Are color fills accelerated ?</p>
 140
 141 </div>
 142 <h2 id="video_mem">video_mem</h2>
 143 <div id="video_mem_CONTENT">
 144 <pre>   my $video_mem = $video_info-&gt;video_mem();
 145
 146 </pre>
 147 <p>Total amount of video memory in Kilobytes, should be accessed only if hw_available == 1, otherwise it is equal to 0</p>
 148
 149 </div>
 150 <h2 id="vfmt">vfmt</h2>
 151 <div id="vfmt_CONTENT">
 152 <pre>   my $vd_pixel_format = $video_info-&gt;vfmt();
 153
 154
 155
 156
 157 </pre>
 158 <p><code>SDL::PixelFormat</code> of the video device</p>
 159
 160 </div>
 161 <h2 id="current_w_current_h">current_w, current_h</h2>
 162 <div id="current_w_current_h_CONTENT">
 163 <pre>   $video_info-&gt;current_w();
 164         $video_info-&gt;current_h();
 165
 166 </pre>
 167 <p>Width and height of the current video mode, or of the desktop mode if <code>SDL_GetVideoInfo</code> was called before <code>SDL::Video::set_video_mode</code> (available since SDL 1.2.10)</p>
 168
 169 </div>
 170 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
 171 <div id="SEE_ALSO_CONTENT">
 172 <p><a href="SDL-Video.html">SDL::Video</a>, <a href="SDL-PixelFormat.html">SDL::PixelFormat</a></p>
 173
 174 </div>
 175 <h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
 176 <div id="AUTHORS_CONTENT">
 177 <p>See <b>AUTHORS</b> in <cite>SDL</cite>.</p>
 178
 179 </div>
 180 </div>