Fixed the pod path in archive
[sdlgit/SDL_perl.git] / lib / pods / SDL / Video.pod
CommitLineData
896b04ee 1=pod
2
3=head1 NAME
4
5SDL::Video - Bindings to the video category in SDL API
6
7=head1 SYNOPSIS
8
9This module is not an object. Please read the
10
11=head1 DESCRIPTION
12
13
14
15=head1 METHODS
16
17=head2 get_video_surface
18
19Returns a pointer to the current display surface
20
21=head2 get_video_info
22
23Returns a pointer to information about the video hardware
24
25=head2 video_driver_name
26
27Obtain the name of the video driver
28
29=head2 list_modes
30
31Returns a pointer to an array of available screen dimensions for the given format and video flags
32
33=head2 set_video_mode
34
35Checks to see if a particular video mode is supported.
36
37=head2 video_mode_ok
38
39Sets up a video mode with the specified width, height and bits-per-pixel.
40
41=head2 update_rect
42
43Makes sure the given area is updated on the given screen.
44
45=head2 update_rects
46
47Makes sure the given list of rectangles is updated on the given screen.
48
49=head2 flip
50
51Swaps screen buffers
52
53=head2 set_colors
54
55Sets a portion of the colormap for the given 8-bit surface.
56
57=head2 set_palette
58
59Sets the colors in the palette of an 8-bit surface.
60
61=head2 set_gamma
62
63Sets the color gamma function for the display
64
65=head2 get_gamma_ramp
66
67Gets the color gamma lookup tables for the display
68
69=head2 set_gmmma_ramp
70
71Sets the color gamma lookup tables for the display
72
73=head2 map_RGB
74
75Maps a RGB color value to a pixel format.
76
77=head2 map_RGBA
78
79Maps a RGBA color value to a pixel format.
80
81=head2 get_RGB
82
83Gets RGB values from a pixel in the specified pixel format.
84
85=head2 get_RGBA
86
87Gets RGBA values from a pixel in the specified pixel format.
88
89=head2 create_RGB_surface_from
90
91Creates an empty SDL::Surface from pixel data
92
93=head2 lock_surface
94
95Locks a surface for direct access.
96
97=head2 unlock_surface
98
99Unlocks a previously locked surface.
100
101=head2 convert_surface
102
103Converts a surface to the same format as another surface.
104
105=head2 display_format
106
107Converts a surface to the display format
108
109=head2 display_format_alpha
110
111Converts a surface to the display format
112
113=head2 load_BMP
114
115
116=head2 save_BMP
117
118
119=head2 set_color_key
120
121
122=head2 set_alpha
123
124
125=head2 set_clip_rect
126
127
128=head2 get_clip_rect
129
130
131=head2 blit_surface
132
133
134=head2 fill_rect
135
136
137=head2 GL_load_library
138
139
140=head2 GL_get_proc_address
141
142
143=head2 GL_get_attribute
144
145
146=head2 GL_set_attribute
147
148
149=head2 GL_swap_buffers
150
151
152=head2 GL_attr
153
154
155=head2 lock_YUV_overlay
156
157
158=head2 unlock_YUV_overlay
159
160
161=head2 display_YUV_overlay
162
163
164
165=head1 SEE ALSO
166
167=head2 Category Objects
168
169L<SDL::Surface>, L<SDL::Overlay>, L<SDL::Color>,
170L<SDL::Rect>, L<SDL::Palette>, L<SDL::PixelFormat>,
171L<SDL::VideoInfo>
172
173=cut