CL_Pen Class Reference
[clanDisplay Display]

Pen description class. More...

#include <pen.h>

List of all members.

Public Member Functions
	CL_Pen ()
	Constructs a pen description.
virtual	~CL_Pen ()
float	get_point_size () const
	Returns the point size.
float	get_max_point_size () const
	Returns the maximum point size.
float	get_min_point_size () const
	Returns the minimum point size.
float	get_point_fade_treshold_size () const
	Returns the treshold size for alpha fading to kick in (Requires multisampling to be enabled.).
void	get_point_distance_attenuation (float &a, float &b, float &c) const
	Get the a, b and c function coefficients used in point distance attenuation calculations.
bool	is_point_antialiased () const
	Return true if antialiasing of points is enabled.
float	get_line_width () const
unsigned short	get_line_stipple_pattern () const
	Returns the line stipple pattern.
int	get_line_stipple_repeat_count () const
	Returns the line stipple repeat count.
bool	is_line_stippled () const
	Returns true if line stippling is enabled.
bool	is_line_antialiased () const
	Returns true if line antialiasing is enabled.
bool	is_using_point_sprites () const
	Returns true if points are being drawn as texture point sprites.
bool	is_using_vertex_program_point_sizes () const
	Enables if points sizes is set by the vertex shader.
CL_PointSpriteOrigin	get_point_sprite_origin () const
	Returns the origin of texture point sprites.
void	set_point_size (float)
	The default value is 1.0.
void	set_max_point_size (float)
	Point size is clamped to the min and max values.
void	set_min_point_size (float)
	Point size is clamped to the min and max values.
void	set_point_fade_treshold_size (float)
	Alpha fade point once minimum size treshold reached. Requires multisampling to be enabled.
void	set_point_distance_attenuation (float a, float b, float c)
	Set the a, b and c function coefficients used in point distance attenuation calculations.
void	enable_point_antialiasing (bool enabled)
	Setting to true enables point antialiasing.
void	set_line_width (float)
	Set the number of times each bit in the stipple pattern is used.
void	set_line_stipple_pattern (unsigned short)
	Set the line stipple pattern.
void	set_line_stipple_repeat_count (int)
	Set the number of times each bit in the stipple pattern is used.
void	enable_line_stipple (bool enabled)
	Setting to true enables line Stippling.
void	enable_line_antialiasing (bool enabled)
	Setting to true enables line 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.
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 (   )

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_line_stipple (  bool  enabled  )

Setting to true enables line Stippling. Initially line stippling 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.

void CL_Pen::enable_vertex_program_point_size (  bool  enable  )

Enables if points sizes is set by the vertex shader.

unsigned short CL_Pen::get_line_stipple_pattern (   )  const

Returns the line stipple pattern.

int CL_Pen::get_line_stipple_repeat_count (   )  const

Returns the line stipple repeat count.

float CL_Pen::get_line_width (   )  const

float CL_Pen::get_max_point_size (   )  const

Returns the maximum point size.

float CL_Pen::get_min_point_size (   )  const

Returns the minimum point size.

void CL_Pen::get_point_distance_attenuation (  float &  a, float &  b, float &  c )  const

Get the a, b and c function coefficients used in point distance attenuation calculations.

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

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_line_stippled (   )  const

Returns true if line stippling is enabled.

bool CL_Pen::is_point_antialiased (   )  const

Return true if antialiasing of points is enabled.

bool CL_Pen::is_using_point_sprites (   )  const

Returns true if points are being drawn as texture point sprites.

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_stipple_pattern (  unsigned  short  )

Set the line stipple pattern. Line stippling masks certain fragments that are produced by rasterization, thus producing a non-continuous line when rendering. Each bit in the pattern is repeated as specified by the function set_line_stipple_repeat_count(int). The initial line stipple value is FFFF (continuos line).

void CL_Pen::set_line_stipple_repeat_count (  int   )

Set the number of times each bit in the stipple pattern is used. The initial value of the line stipple repeat count is 1. The value is clamped to the range 1-256

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_max_point_size (  float   )

Point size is clamped to the min and max values.

void CL_Pen::set_min_point_size (  float   )

Point size is clamped to the min and max values.

void CL_Pen::set_point_distance_attenuation (  float  a, float  b, float  c )

Set the a, b and c function coefficients used in point distance attenuation calculations.

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   )

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:

• pen.h

---