lib/SDL/PixelFormat.pm

   1 package SDL::PixelFormat;
   2 use strict;
   3 use warnings;
   4 require Exporter;
   5 require DynaLoader;
   6 our @ISA = qw(Exporter DynaLoader);
   7 bootstrap SDL::PixelFormat;
   8
   9 1;
  10
  11 __END__
  12
  13 =pod
  14
  15 =head1 NAME
  16
  17 SDL::PixelFormat - Stores surface format information
  18
  19 =head1 SYNOPSIS
  20
  21         my $surface = SDL::Surface->new( ...
  22         $surface->format; #this returns the PixelFormat object attached to this surface
  23
  24 PixelFormat is only created in a C<SDL::Surface>. This module only provides getters to the surface's pixelformat. Later on we will provide setting capability.
  25
  26
  27 =head1 DESCRIPTION
  28
  29 An C<SDL::PixelFormat > stores surface format information
  30
  31 =head1 METHODS
  32
  33 =head2  palette
  34
  35         $surface->format->palette;
  36
  37 Returns the C<SDL_Palette> and L<SDL::Palette> of the format of the surface.
  38
  39 =head2  BitsPerPixel
  40
  41         $surface->format->BitsPerPixel;
  42
  43 The number of bits used to represent each pixel in a surface. Usually 8, 16, 24 or 32. (1 to 7 are not allowed when creating a surface or open a video mode
  44
  45 =head2 BytesPerPixel
  46
  47         $surface->format->BytesPerPixel;
  48
  49 The number of bytes used to represent each pixel in a surface. Usually one to four.
  50
  51 =head2 [RGBA]loss
  52
  53         $surface->format->Rloss; #red   loss
  54         $surface->format->Bloss; #blue  loss
  55         $surface->format->Gloss; #green loss
  56         $surface->format->Aloss; #alpha loss
  57
  58 Precision loss of each color component (2[RGBA]loss)
  59
  60 =head2 [RGBA]shift
  61
  62         $surface->format->Rshift; #red   shift
  63         $surface->format->Bshift; #blue  shift
  64         $surface->format->Gshift; #green shift
  65         $surface->format->Ashift; #alpha shift
  66
  67 Binary left shift of each color component in the pixel value
  68
  69
  70 =head2 [RGBA]mask
  71
  72         $surface->format->Rmask; #red   mask
  73         $surface->format->Bmask; #blue  mask
  74         $surface->format->Gmask; #green mask
  75         $surface->format->Amask; #alpha mask
  76
  77 Binary left shift of each color component in the pixel value
  78
  79 =head2 colorkey
  80
  81         $surface->format->colorkey;
  82
  83 Pixel value of transparent pixels.
  84
  85 =head2 alpha
  86
  87         $surface->format->alpha;
  88
  89 Overall surface alpha value
  90
  91
  92
  93 =head1 SEE ALSO
  94
  95 L<SDL::Surface>
  96
  97 =cut