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