lib/SDL/Video.pm

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