Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > main-release > by-pkgid > 4a7a03b9c12105ca7dcc2eab88d3704a > files > 234

clanlib0.6-docs-0.6.5-36mdv2010.1.x86_64.rpm


<html>
<head><title>ClanLib Reference: CL_Target</title></head>
<body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0>
<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr>
<tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table>
<table align=center border=0 cellspacing=10> <tr>
<td><a href="entire_class_index.html">Entire Class Index</a></td>
<td><a href="class_index.html">Main Class Index</a></td>
<td><a href="cross_index.html">Cross Index</a></td>
<td><a href="global_index.html">Global Index</a></td>
</table><h1 align=center>Class CL_Target</h1><p>
<b>  Target class in ClanLib.</b><br>
Contained in: <a href="global_index.html">global</a><br>
Derived from:
<i>none</i>
<br>
Derived by:
<a href="CL_SurfaceProvider.html">CL_SurfaceProvider</a>
<br>Group: Display (Display 2D)
<p>
#include &lt;ClanLib/display.h&gt;
<p>
<hr noshade>
<table border=0>
<tr><td colspan=3><h3>public function member index:</h3></td>
<tr valign=top><td align=left><h3>Construction:</h3></td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Target.html#151"><tt><font color=blue><b>CL_Target</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_Target.html#152"><tt><font color=blue><b>~CL_Target</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=left><h3>Attributes:</h3></td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_Target.html#153"><tt><font color=blue><b>is_video</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#154"><tt><font color=blue><b>lock</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#155"><tt><font color=blue><b>unlock</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt>*</tt> </td><td align=right><a href="CL_Target.html#156"><tt><font color=blue><b>get_data</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#157"><tt><font color=blue><b>get_num_frames</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#158"><tt><font color=blue><b>get_width</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#159"><tt><font color=blue><b>get_height</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#160"><tt><font color=blue><b>get_pitch</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#161"><tt><font color=blue><b>get_depth</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#162"><tt><font color=blue><b>get_bytes_per_pixel</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_Target.html#163"><tt><font color=blue><b>is_indexed</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#164"><tt><font color=blue><b>get_red_mask</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#165"><tt><font color=blue><b>get_green_mask</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#166"><tt><font color=blue><b>get_blue_mask</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#167"><tt><font color=blue><b>get_alpha_mask</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <a href="CL_Palette.html"><tt><font color=navy><b>CL_Palette</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Target.html#168"><tt><font color=blue><b>get_palette</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#169"><tt><font color=blue><b>push_clip_rect</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#170"><tt><font color=blue><b>push_clip_rect</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_ClipRect.html"><tt><font color=navy><b>CL_ClipRect</b></font></tt></a>& <tt><font color=blue>rect</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <a href="CL_ClipRect.html"><tt><font color=navy><b>CL_ClipRect</b></font></tt></a></tt> </td><td align=right><a href="CL_Target.html#171"><tt><font color=blue><b>get_clip_rect</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#172"><tt><font color=blue><b>set_clip_rect</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_ClipRect.html"><tt><font color=navy><b>CL_ClipRect</b></font></tt></a>& <tt><font color=blue>rect</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#173"><tt><font color=blue><b>pop_clip_rect</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#174"><tt><font color=blue><b>push_translate_offset</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#175"><tt><font color=blue><b>push_translate_offset</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#176"><tt><font color=blue><b>get_translate_offset_x</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#177"><tt><font color=blue><b>get_translate_offset_y</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#178"><tt><font color=blue><b>set_translate_offset</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#179"><tt><font color=blue><b>pop_translate_offset</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=left><h3>Operations:</h3></td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#180"><tt><font color=blue><b>draw_pixel</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>color</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#181"><tt><font color=blue><b>draw_pixel</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>a</font></tt> = 1.0)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#182"><tt><font color=blue><b>get_pixel</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>, <tt><font color=purple>float</font></tt>* <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt>* <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt>* <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt>* <tt><font color=blue>a</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Target.html#183"><tt><font color=blue><b>get_pixel</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#184"><tt><font color=blue><b>flip_vertical</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#185"><tt><font color=blue><b>flip_horizontal</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#186"><tt><font color=blue><b>fill_rect</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>x2</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y2</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>a</font></tt> = 1.0)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#187"><tt><font color=blue><b>draw_rect</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>x2</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y2</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>a</font></tt> = 1.0)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Target.html#188"><tt><font color=blue><b>draw_line</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>x2</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y2</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>a</font></tt> = 1.0)</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
  The <a href="CL_Target.html">CL_Target</a> class represents a renderer target in ClanLib. This can  be a part of the framebuffer, or a piece of memory specified by the  application.<br><br>  This class contains a set of functions used to describe a piece of  memory, things such as the width, height, color masks and depth. This  information can then be used by ClanLib or the application to access the  given piece of memory.<br><br>  To access the memory itself, call get_data() after a call to lock().  When you are finished accessing the memory, call unlock(). Note that  after the unlock() call, the pointer obtained from get_data() will be  invalid, and new call to lock() is required before get_data() will return  anything valid.<br><br>  CL_Target contain a set of functions doing simple primitive  operations: draw boxes, lines and clipping. These are provided for  convience so you won't have to do such simple things manually in a lock  session.<br><br>  CL_Surface supports blitting to a target and all surface providers are  inheritated from a target. This means that you can do surface to provider  blitting. ClanLib has a special surface provider called <a href="CL_Canvas.html">CL_Canvas</a> which  you should use to easilly build a new image.<br><p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="151"><font size=+1><b>CL_Target::CL_Target</b></font></a> -   Target Constructor<br><tt></tt> <a href="CL_Target.html#151"><tt><font color=blue><b>CL_Target</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="188"><font size=+1><b>CL_Target::draw_line</b></font></a> -   Draw a line from ('x1', 'y1') to ('x2', 'y2') using the color  ('r', 'g', 'b', 'a').<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#188"><tt><font color=blue><b>draw_line</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>x2</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y2</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>a</font></tt> = 1.0)</tt>;<br><blockquote>  x1 - Leftmost x-coordinate. //FIXME<br>  y1 - Upper y-coordinate.<br>  x2 - Rightmost x-coordinate.<br>  y2 - Lower y-coordinate.<br>  r - Red component of the filled color.<br>  g - Green component of the filled color.<br>  b - Blue component of the filled color.<br>  a - Alpha component of the filled color.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="180"><font size=+1><b>CL_Target::draw_pixel</b></font></a> -   Draw Pixel<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#180"><tt><font color=blue><b>draw_pixel</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>color</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="181"><font size=+1><b>CL_Target::draw_pixel</b></font></a> -   Draw Pixel<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#181"><tt><font color=blue><b>draw_pixel</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>a</font></tt> = 1.0)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="187"><font size=+1><b>CL_Target::draw_rect</b></font></a> -   Draw a rectangle from ('x1', 'y1') to ('x2', 'y2') using the color  ('r', 'g', 'b', 'a').<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#187"><tt><font color=blue><b>draw_rect</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>x2</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y2</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>a</font></tt> = 1.0)</tt>;<br><blockquote>  x1 - Leftmost x-coordinate.<br>  y1 - Upper y-coordinate.<br>  x2 - Rightmost x-coordinate.<br>  y2 - Lower y-coordinate.<br>  r - Red component of the filled color.<br>  g - Green component of the filled color.<br>  b - Blue component of the filled color.<br>  a - Alpha component of the filled color.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="186"><font size=+1><b>CL_Target::fill_rect</b></font></a> -   Draw a filled rectangle from ('x1', 'y1') to ('x2', 'y2') using the color  ('r', 'g', 'b', 'a').<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#186"><tt><font color=blue><b>fill_rect</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y1</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>x2</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y2</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>a</font></tt> = 1.0)</tt>;<br><blockquote>  x1 - Leftmost x-coordinate.<br>  y1 - Upper y-coordinate.<br>  x2 - Rightmost x-coordinate.<br>  y2 - Lower y-coordinate.<br>  r - Red component of the filled color.<br>  g - Green component of the filled color.<br>  b - Blue component of the filled color.<br>  a - Alpha component of the filled color.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="185"><font size=+1><b>CL_Target::flip_horizontal</b></font></a> -   Flips along the X-axis<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#185"><tt><font color=blue><b>flip_horizontal</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="184"><font size=+1><b>CL_Target::flip_vertical</b></font></a> -   Flips along the Y-axis<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#184"><tt><font color=blue><b>flip_vertical</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="167"><font size=+1><b>CL_Target::get_alpha_mask</b></font></a> -   Returns the alpha mask by the target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#167"><tt><font color=blue><b>get_alpha_mask</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="166"><font size=+1><b>CL_Target::get_blue_mask</b></font></a> -   Returns the blue color mask by the target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#166"><tt><font color=blue><b>get_blue_mask</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="162"><font size=+1><b>CL_Target::get_bytes_per_pixel</b></font></a> -   Returns the bytes per pixel of the target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#162"><tt><font color=blue><b>get_bytes_per_pixel</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="171"><font size=+1><b>CL_Target::get_clip_rect</b></font></a> -   Returns the current clipping rectangle.<br><tt><tt>virtual</tt> <a href="CL_ClipRect.html"><tt><font color=navy><b>CL_ClipRect</b></font></tt></a></tt> <a href="CL_Target.html#171"><tt><font color=blue><b>get_clip_rect</b></font></tt></a><tt>()</tt>;<br><blockquote>  Returns - The current clipping rectangle.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="156"><font size=+1><b>CL_Target::get_data</b></font></a> -   Returns a pointer to the target data. Only valid between lock/unlock  calls.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt>*</tt> <a href="CL_Target.html#156"><tt><font color=blue><b>get_data</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote>  Returns - A pointer that points to the beginning of the target pixel data.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="161"><font size=+1><b>CL_Target::get_depth</b></font></a> -   Returns the depth used by the target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#161"><tt><font color=blue><b>get_depth</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="165"><font size=+1><b>CL_Target::get_green_mask</b></font></a> -   Returns the green color mask by the target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#165"><tt><font color=blue><b>get_green_mask</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="159"><font size=+1><b>CL_Target::get_height</b></font></a> -   Returns the height of the target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#159"><tt><font color=blue><b>get_height</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="157"><font size=+1><b>CL_Target::get_num_frames</b></font></a> -   Returns the number of frames available on this target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#157"><tt><font color=blue><b>get_num_frames</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="168"><font size=+1><b>CL_Target::get_palette</b></font></a> -   Returns the palette used by the target.<br><tt><tt>virtual</tt> <a href="CL_Palette.html"><tt><font color=navy><b>CL_Palette</b></font></tt></a>*</tt> <a href="CL_Target.html#168"><tt><font color=blue><b>get_palette</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="160"><font size=+1><b>CL_Target::get_pitch</b></font></a> -   Returns the pitch (bytes per line) used by the target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#160"><tt><font color=blue><b>get_pitch</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="182"><font size=+1><b>CL_Target::get_pixel</b></font></a> -   Get Pixel<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#182"><tt><font color=blue><b>get_pixel</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>, <tt><font color=purple>float</font></tt>* <tt><font color=blue>r</font></tt>, <tt><font color=purple>float</font></tt>* <tt><font color=blue>g</font></tt>, <tt><font color=purple>float</font></tt>* <tt><font color=blue>b</font></tt>, <tt><font color=purple>float</font></tt>* <tt><font color=blue>a</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="183"><font size=+1><b>CL_Target::get_pixel</b></font></a> -   Get Pixel<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#183"><tt><font color=blue><b>get_pixel</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="164"><font size=+1><b>CL_Target::get_red_mask</b></font></a> -   Returns the red color mask used by the target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#164"><tt><font color=blue><b>get_red_mask</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="176"><font size=+1><b>CL_Target::get_translate_offset_x</b></font></a> -   Returns the current effective x-axis translation offset.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#176"><tt><font color=blue><b>get_translate_offset_x</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="177"><font size=+1><b>CL_Target::get_translate_offset_y</b></font></a> -   Returns the current effective y-axis translation offset.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#177"><tt><font color=blue><b>get_translate_offset_y</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="158"><font size=+1><b>CL_Target::get_width</b></font></a> -   Returns the width of the target.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Target.html#158"><tt><font color=blue><b>get_width</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="163"><font size=+1><b>CL_Target::is_indexed</b></font></a> -   Returns whether the target uses an indexed color mode or not.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_Target.html#163"><tt><font color=blue><b>is_indexed</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="153"><font size=+1><b>CL_Target::is_video</b></font></a> -   Returns true if in video memory.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_Target.html#153"><tt><font color=blue><b>is_video</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote>  Returns - True if stored in video memory, false otherwise.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="154"><font size=+1><b>CL_Target::lock</b></font></a> -   Locks the target. This allows access to the target data using the  get_data() function call.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#154"><tt><font color=blue><b>lock</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="173"><font size=+1><b>CL_Target::pop_clip_rect</b></font></a> -   Pop the clipping rectangle last pushed onto the stack.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#173"><tt><font color=blue><b>pop_clip_rect</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="179"><font size=+1><b>CL_Target::pop_translate_offset</b></font></a> -   Pops the last pushed translation offset from the translation offset  stack. If the stack is empty, nothing will happen, and if the last  translation offset is popped, the translation offset will be set to 0,0<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#179"><tt><font color=blue><b>pop_translate_offset</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="169"><font size=+1><b>CL_Target::push_clip_rect</b></font></a> -   Pushes the current clipping rectangle onto the cliprect stack.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#169"><tt><font color=blue><b>push_clip_rect</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="170"><font size=+1><b>CL_Target::push_clip_rect</b></font></a> -   Pushes the current clipping rectangle onto the cliprect stack. It then clips   the passed rectangle 'rect' with the current one, and uses the result as the   new clipping rect.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#170"><tt><font color=blue><b>push_clip_rect</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_ClipRect.html"><tt><font color=navy><b>CL_ClipRect</b></font></tt></a>& <tt><font color=blue>rect</font></tt>)</tt>;<br><blockquote>  rect - The new clipping rectangle to be clipped with the current cliprect and then used.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="174"><font size=+1><b>CL_Target::push_translate_offset</b></font></a> -   Pushes the current translation rectangle onto the cliprect stack.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#174"><tt><font color=blue><b>push_translate_offset</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="175"><font size=+1><b>CL_Target::push_translate_offset</b></font></a> -   Push translation offset onto translation stack. This offset will  affect any subsequent display operations on the displaycard, by  translating the position of the display operation with the offset.  The offset will be offset by any previous offsets pushed onto the stack,  eg. it inherits the previous offset.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#175"><tt><font color=blue><b>push_translate_offset</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="172"><font size=+1><b>CL_Target::set_clip_rect</b></font></a> -   Sets the current clipping rectangle. This is an absolute set, so it doesn't<br>  get clipped with the previous one.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#172"><tt><font color=blue><b>set_clip_rect</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_ClipRect.html"><tt><font color=navy><b>CL_ClipRect</b></font></tt></a>& <tt><font color=blue>rect</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="178"><font size=+1><b>CL_Target::set_translate_offset</b></font></a> -   Sets the translation offset as a new absolute translation offset.  The new offset will disregard any previous offset's, but will not  empty the translation stack. The new translation offset will affect  any subsequent display operations on the displaycard, by  translating the position of the display operation with the offset<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#178"><tt><font color=blue><b>set_translate_offset</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="155"><font size=+1><b>CL_Target::unlock</b></font></a> -   Unlock the target. Must be called after you're finished with modifying  the target data.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Target.html#155"><tt><font color=blue><b>unlock</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="152"><font size=+1><b>CL_Target::~CL_Target</b></font></a> -   Target destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_Target.html#152"><tt><font color=blue><b>~CL_Target</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<hr noshade>
<h2>Variable Member Descriptions:</h2>
<hr noshade>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional