Public Member Functions

CL_Pen Class Reference
[clanDisplay Display]

Pen description class. More...

#include <pen.h>

List of all members.

Public Member Functions

 CL_Pen ()
 Construction.
virtual ~CL_Pen ()
void enable_line_antialiasing (bool enabled)
 Setting to true enables line antialiasing.
void enable_point_antialiasing (bool enabled)
 Setting to true enables point antialiasing.
void enable_point_sprite (bool enable)
 Enables if points are being drawn as texture point sprites.
void enable_vertex_program_point_size (bool enable)
 Enables if points sizes is set by the vertex shader.
float get_line_width () const
float get_point_fade_treshold_size () const
 Returns the treshold size for alpha fading to kick in (Requires multisampling to be enabled.).
float get_point_size () const
 Attributes.
CL_PointSpriteOrigin get_point_sprite_origin () const
 Returns the origin of texture point sprites.
bool is_line_antialiased () const
 Returns true if line antialiasing is enabled.
bool is_using_vertex_program_point_sizes () const
 Enables if points sizes is set by the vertex shader.
void set_line_width (float)
 Set the number of times each bit in the stipple pattern is used.
void set_point_fade_treshold_size (float)
 Alpha fade point once minimum size treshold reached. Requires multisampling to be enabled.
void set_point_size (float)
 Operations.
void set_point_sprite_origin (CL_PointSpriteOrigin origin)
 Sets the origin of texture point sprites.

Detailed Description

Pen description class.


Constructor & Destructor Documentation

CL_Pen::CL_Pen (  ) 

Construction.

Constructs a pen description.

virtual CL_Pen::~CL_Pen (  )  [virtual]

Member Function Documentation

void CL_Pen::enable_line_antialiasing ( bool  enabled  ) 

Setting to true enables line antialiasing.

Initially antialiasing of lines is disabled.

void CL_Pen::enable_point_antialiasing ( bool  enabled  ) 

Setting to true enables point antialiasing.

Antialiasing of points is disabled by default

void CL_Pen::enable_point_sprite ( bool  enable  ) 

Enables if points are being drawn as texture point sprites.

This function is not used. Point sprites are always enabled. Except for clanGL1 where you should call cl1Enable(GL_POINT_SPRITE) if you require it
This function is to be removed in ClanLib 2.4

void CL_Pen::enable_vertex_program_point_size ( bool  enable  ) 

Enables if points sizes is set by the vertex shader.

float CL_Pen::get_line_width (  )  const
float CL_Pen::get_point_fade_treshold_size (  )  const

Returns the treshold size for alpha fading to kick in (Requires multisampling to be enabled.).

float CL_Pen::get_point_size (  )  const

Attributes.

Returns the point size

CL_PointSpriteOrigin CL_Pen::get_point_sprite_origin (  )  const

Returns the origin of texture point sprites.

bool CL_Pen::is_line_antialiased (  )  const

Returns true if line antialiasing is enabled.

bool CL_Pen::is_using_vertex_program_point_sizes (  )  const

Enables if points sizes is set by the vertex shader.

void CL_Pen::set_line_width ( float   ) 

Set the number of times each bit in the stipple pattern is used.

The initial value of the line width is 1.0.

void CL_Pen::set_point_fade_treshold_size ( float   ) 

Alpha fade point once minimum size treshold reached. Requires multisampling to be enabled.

void CL_Pen::set_point_size ( float   ) 

Operations.

The default value is 1.0

void CL_Pen::set_point_sprite_origin ( CL_PointSpriteOrigin  origin  ) 

Sets the origin of texture point sprites.


The documentation for this class was generated from the following file: