/lib/pods/SDL/GFX/Primitives.pod

http://github.com/PerlGameDev/SDL · Unknown · 222 lines · 128 code · 94 blank · 0 comment · 0 complexity · 944048531983b635169d9a73ff1239c6 MD5 · raw file 

    

  1. =head1 NAME
    2. 

  2. 

  3. SDL::GFX::Primitives - basic drawing functions
    4. 

  4. 

  5. =head1 CATEGORY
    6. 

  6. 

  7. GFX
    8. 

  8. 

  9. =head1	DESCRIPTION
    10. 

  10. 

  11. All functions take an SDL::Surface object as first parameter. This can be a new surface that will be blitted afterwards, can be an surface 
    12. 

  12. obtained by L<SDL::Video::set_video_mode|SDL::Video/"set_video_mode"> or can be an L<SDLx::App>.
    13. 

  13. 

  14. The C<color> values for the C<_color> functions are C<0xRRGGBBAA> (32bit), even if the surface uses e. g. 8bit colors.
    15. 

  15. 

  16. =head1	METHODS
    17. 

  17. 

  18. =head2	pixel
    19. 

  19. 

  20.  int SDL::GFX::Primitives::pixel_color( $surface, $x, $y, $color );
    21. 

  21.  int SDL::GFX::Primitives::pixel_RGBA(  $surface, $x, $y, $r, $g, $b, $a );
    22. 

  22. 

  23. Draws a pixel at point C<x>/C<$y>. You can pass the color by C<0xRRGGBBAA> or by passing 4 values. One for red, green, blue and alpha.
    24. 

  24. 

  25.  use SDL;
    26. 

  26.  use SDL::Video;
    27. 

  27.  use SDL::Surface;
    28. 

  28.  use SDL::GFX::Primitives;
    29. 

  29. 

  30.  my $surface = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
    31. 

  31.  
    32. 

  32.  SDL::GFX::Primitives::pixel_color($surface, 2, 2, 0xFF0000FF);             # red pixel
    33. 

  33.  SDL::GFX::Primitives::pixel_RGBA( $surface, 4, 4, 0x00, 0xFF, 0x00, 0xFF); # green pixel
    34. 

  34. 

  35. =head2	hline
    36. 

  36. 

  37.  int SDL::GFX::Primitives::hline_color( $surface, $x1, $x2, $y, $color );
    38. 

  38.  int SDL::GFX::Primitives::hline_RGBA(  $surface, $x1, $x2, $y, $r, $g, $b, $a );
    39. 

  39. 

  40. Draws a line horizontally from C<$x1>/C<$y> to C<$x2>/C<$y>.
    41. 

  41. 

  42. =head2	vline
    43. 

  43. 

  44.  int SDL::GFX::Primitives::vline_color( $surface, $x, $y1, $y2, $color );
    45. 

  45.  int SDL::GFX::Primitives::vline_RGBA(  $surface, $x, $y1, $y2, $r, $g, $b, $a );
    46. 

  46. 

  47. Draws a line vertically from C<$x>/C<$y1> to C<$x>/C<$y2>.
    48. 

  48. 

  49. =head2	rectangle
    50. 

  50. 

  51.  int SDL::GFX::Primitives::rectangle_color( $surface, $x1, $y1, $x2, $y2, $color );
    52. 

  52.  int SDL::GFX::Primitives::rectangle_RGBA(  $surface, $x1, $y1, $x2, $y2, $r, $g, $b, $a );
    53. 

  53. 

  54. Draws a rectangle. Upper left edge will be at C<$x1>/C<$y1> and lower right at C<$x2>/C<$y>. The colored border has a width of 1 pixel.
    55. 

  55. 

  56. =head2	box
    57. 

  57. 

  58.  int SDL::GFX::Primitives::box_color( $surface, $x1, $y1, $x2, $y2, $color );
    59. 

  59.  int SDL::GFX::Primitives::box_RGBA(  $surface, $x1, $y1, $x2, $y2, $r, $g, $b, $a );
    60. 

  60. 

  61. Draws a filled rectangle.
    62. 

  62. 

  63. =head2	line
    64. 

  64. 

  65.  int SDL::GFX::Primitives::line_color( $surface, $x1, $y1, $x2, $y2, $color );
    66. 

  66.  int SDL::GFX::Primitives::line_RGBA(  $surface, $x1, $y1, $x2, $y2, $r, $g, $b, $a );
    67. 

  67. 

  68. Draws a free line from C<$x1>/C<$y1> to C<$x2>/C<$y>.
    69. 

  69. 

  70. =head2	aaline
    71. 

  71. 

  72.  int SDL::GFX::Primitives::aaline_color( $surface, $x1, $y1, $x2, $y2, $color );
    73. 

  73.  int SDL::GFX::Primitives::aaline_RGBA(  $surface, $x1, $y1, $x2, $y2, $r, $g, $b, $a );
    74. 

  74. 

  75. Draws a free line from C<$x1>/C<$y1> to C<$x2>/C<$y>. This line is anti aliased.
    76. 

  76. 

  77. =head2	circle
    78. 

  78. 

  79.  int SDL::GFX::Primitives::circle_color( $surface, $x, $y, $r, $color );
    80. 

  80.  int SDL::GFX::Primitives::circle_RGBA(  $surface, $x, $y, $rad, $r, $g, $b, $a );
    81. 

  81. 

  82. =head2	arc
    83. 

  83. 

  84.  int SDL::GFX::Primitives::arc_color( $surface, $x, $y, $r, $start, $end, $color );
    85. 

  85.  int SDL::GFX::Primitives::arc_RGBA(  $surface, $x, $y, $rad, $start, $end, $r, $g, $b, $a );
    86. 

  86. 

  87. B<Note>: You need lib SDL_gfx 2.0.17 or greater for this function.
    88. 

  88. 

  89. =head2	aacircle
    90. 

  90. 

  91.  int SDL::GFX::Primitives::aacircle_color( $surface, $x, $y, $r, $color );
    92. 

  92.  int SDL::GFX::Primitives::aacircle_RGBA(  $surface, $x, $y, $rad, $r, $g, $b, $a );
    93. 

  93. 

  94. B<Note>: You need lib SDL_gfx 2.0.17 or greater for this function.
    95. 

  95. 

  96. =head2	filled_circle
    97. 

  97. 

  98.  int SDL::GFX::Primitives::filled_circle_color( $surface, $x, $y, $r, $color );
    99. 

  99.  int SDL::GFX::Primitives::filled_circle_RGBA(  $surface, $x, $y, $rad, $r, $g, $b, $a );
    100. 

  100. 

  101. =head2	ellipse
    102. 

  102. 

  103.  int SDL::GFX::Primitives::ellipse_color( $surface, $x, $y, $rx, $ry, $color );
    104. 

  104.  int SDL::GFX::Primitives::ellipse_RGBA(  $surface, $x, $y, $rx, $ry, $r, $g, $b, $a );
    105. 

  105. 

  106. =head2	aaellipse
    107. 

  107. 

  108.  int SDL::GFX::Primitives::aaellipse_color( $surface, $xc, $yc, $rx, $ry, $color );
    109. 

  109.  int SDL::GFX::Primitives::aaellipse_RGBA(  $surface, $x, $y, $rx, $ry, $r, $g, $b, $a );
    110. 

  110. 

  111. =head2	filled_ellipse
    112. 

  112. 

  113.  int SDL::GFX::Primitives::filled_ellipse_color( $surface, $x, $y, $rx, $ry, $color );
    114. 

  114.  int SDL::GFX::Primitives::filled_ellipse_RGBA(  $surface, $x, $y, $rx, $ry, $r, $g, $b, $a );
    115. 

  115. 

  116. =head2	pie
    117. 

  117. 

  118.  int SDL::GFX::Primitives::pie_color( $surface, $x, $y, $rad, $start, $end, $color );
    119. 

  119.  int SDL::GFX::Primitives::pie_RGBA(  $surface, $x, $y, $rad, $start, $end, $r, $g, $b, $a );
    120. 

  120. 

  121. This draws an opened pie. C<$start> and C<$end> are degree values. C<0> is at right, C<90> at bottom, C<180> at left and C<270> degrees at top.
    122. 

  122. 

  123. =head2	filled_pie
    124. 

  124. 

  125.  int SDL::GFX::Primitives::filled_pie_color( $surface, $x, $y, $rad, $start, $end, $color );
    126. 

  126.  int SDL::GFX::Primitives::filled_pie_RGBA(  $surface, $x, $y, $rad, $start, $end, $r, $g, $b, $a );
    127. 

  127. 

  128. =head2	trigon
    129. 

  129. 

  130.  int SDL::GFX::Primitives::trigon_color( $surface, $x1, $y1, $x2, $y2, $x3, $y3, $color );
    131. 

  131.  int SDL::GFX::Primitives::trigon_RGBA(  $surface, $x1, $y1, $x2, $y2, $x3, $y3, $r, $g, $b, $a );
    132. 

  132. 

  133. =head2	aatrigon
    134. 

  134. 

  135.  int SDL::GFX::Primitives::aatrigon_color( $surface, $x1, $y1, $x2, $y2, $x3, $y3, $color );
    136. 

  136.  int SDL::GFX::Primitives::aatrigon_RGBA(  $surface, $x1, $y1, $x2, $y2, $x3, $y3, $r, $g, $b, $a );
    137. 

  137. 

  138. =head2	filled_trigon
    139. 

  139. 

  140.  int SDL::GFX::Primitives::filled_trigon_color( $surface, $x1, $y1, $x2, $y2, $x3, $y3, $color );
    141. 

  141.  int SDL::GFX::Primitives::filled_trigon_RGBA(  $surface, $x1, $y1, $x2, $y2, $x3, $y3, $r, $g, $b, $a );
    142. 

  142. 

  143. =head2	polygon
    144. 

  144. 

  145.  int SDL::GFX::Primitives::polygon_color( $surface, $vx, $vy, $n, $color );
    146. 

  146.  int SDL::GFX::Primitives::polygon_RGBA(  $surface, $vx, $vy, $n, $r, $g, $b, $a );
    147. 

  147. 

  148. Example:
    149. 

  149. 

  150.  SDL::GFX::Primitives::polygon_color($display, [262, 266, 264, 266, 262], [243, 243, 245, 247, 247], 5, 0xFF0000FF);
    151. 

  151. 

  152. =head2	aapolygon
    153. 

  153. 

  154.  int SDL::GFX::Primitives::aapolygon_color( $surface, $vx, $vy, $n, $color );
    155. 

  155.  int SDL::GFX::Primitives::aapolygon_RGBA(  $surface, $vx, $vy, $n, $r, $g, $b, $a );
    156. 

  156. 

  157. =head2	filled_polygon
    158. 

  158. 

  159.  int SDL::GFX::Primitives::filled_polygon_color( $surface, $vx, $vy, $n, $color );
    160. 

  160.  int SDL::GFX::Primitives::filled_polygon_RGBA(  $surface, $vx, $vy, $n, $r, $g, $b, $a );
    161. 

  161. 

  162. =head2	textured_polygon
    163. 

  163. 

  164.  int SDL::GFX::Primitives::textured_polygon( $surface, $vx, $vy, $n, $texture, $texture_dx, $texture_dy );
    165. 

  165. 

  166. =head2	filled_polygon_MT
    167. 

  167. 

  168.  int SDL::GFX::Primitives::filled_polygon_color_MT( $surface, $vx, $vy, $n, $color, $polyInts, $polyAllocated );
    169. 

  169.  int SDL::GFX::Primitives::filled_polygon_RGBA_MT(  $surface, $vx, $vy, $n, $r, $g, $b, $a, $polyInts, $polyAllocated );
    170. 

  170. 

  171. B<Note>: You need lib SDL_gfx 2.0.17 or greater for this function.
    172. 

  172. 

  173. =head2	textured_polygon_MT
    174. 

  174. 

  175.  int SDL::GFX::Primitives::textured_polygon_MT( $surface, $vx, $vy, $n, $texture, $texture_dx, $texture_dy, $polyInts, $polyAllocated );
    176. 

  176. 

  177. B<Note>: You need lib SDL_gfx 2.0.17 or greater for this function.
    178. 

  178. 

  179. =head2	bezier
    180. 

  180. 

  181.  int SDL::GFX::Primitives::bezier_color( $surface, $vx, $vy, $n, $s, $color );
    182. 

  182.  int SDL::GFX::Primitives::bezier_RGBA(  $surface, $vx, $vy, $n, $s, $r, $g, $b, $a );
    183. 

  183. 

  184. C<$n> is the number of elements in C<$vx> and C<$vy>, and C<$s> is the number of steps. So the bigger C<$s> is, the smother it becomes.
    185. 

  185. 

  186. Example:
    187. 

  187. 

  188.  SDL::GFX::Primitives::bezier_color($display, [390, 392, 394, 396], [243, 255, 235, 247], 4, 20, 0xFF00FFFF);
    189. 

  189. 

  190. =head2	character
    191. 

  191. 

  192.  int SDL::GFX::Primitives::character_color( $surface, $x, $y, $c, $color );
    193. 

  193.  int SDL::GFX::Primitives::character_RGBA(  $surface, $x, $y, $c, $r, $g, $b, $a );
    194. 

  194. 

  195. C<$c> is the character that will be drawn at C<$x>,C<$y>.
    196. 

  196. 

  197. =head2	string
    198. 

  198. 

  199.  int SDL::GFX::Primitives::string_color( $surface, $x, $y, $c, $color );
    200. 

  200.  int SDL::GFX::Primitives::string_RGBA(  $surface, $x, $y, $c, $r, $g, $b, $a );
    201. 

  201. 

  202. =head2	set_font
    203. 

  203. 

  204.  void SDL::GFX::Primitives::set_font(fontdata, $cw, $ch );
    205. 

  205. 

  206. The fontsets are included in the SDL_gfx distribution. Check L<http://www.ferzkopp.net/joomla/content/view/19/14/> for more.
    207. 

  207. 

  208. Example:
    209. 

  209. 

  210.  my $font = '';
    211. 

  211.  open(FH, '<', 'data/5x7.fnt');
    212. 

  212.  binmode(FH);
    213. 

  213.  read(FH, $font, 4096);
    214. 

  214.  close(FH);
    215. 

  215. 

  216.  SDL::GFX::Primitives::set_font($font, 5, 7);
    217. 

  217. 

  218. =head1 AUTHORS
    219. 

  219. 

  220. See L<SDL/AUTHORS>.
    221.