fastuidraw::GlyphAttributePacker Class Reference

A GlyphAttributePacker provides an interface to customize how glyph attribute and index data is realized by a GlyphRun and GlyphSequence. More...

#include <glyph_attribute_packer.hpp>

Inheritance diagram for fastuidraw::GlyphAttributePacker:

Public Member Functions
virtual void	compute_needed_room (GlyphRenderer glyph_renderer, c_array< const GlyphAttribute > glyph_attributes, unsigned int *out_num_indices, unsigned int *out_num_attributes) const =0
virtual void	glyph_position (Glyph glyph, const vec2 position, float scale_factor, vec2 *p_bl, vec2 *p_tr) const =0
virtual void	glyph_position_from_metrics (GlyphMetrics metrics, const vec2 position, float scale_factor, vec2 *p_bl, vec2 *p_tr) const =0
virtual void	realize_attribute_data (GlyphRenderer glyph_renderer, c_array< const GlyphAttribute > glyph_attributes, c_array< PainterIndex > dst_indices, c_array< PainterAttribute > dst_attribs, const vec2 p_bl, const vec2 p_tr) const =0
Public Member Functions inherited from fastuidraw::reference_counted_base< T, Counter >
	reference_counted_base (void)

Static Public Member Functions
static const GlyphAttributePacker &	standard_packer (enum PainterEnums::screen_orientation orientation, enum PainterEnums::glyph_layout_type layout)
Static Public Member Functions inherited from fastuidraw::reference_counted_base< T, Counter >
static void	add_reference (const reference_counted_base< T, Counter > *p)
static void	remove_reference (const reference_counted_base< T, Counter > *p)

Detailed Description

A GlyphAttributePacker provides an interface to customize how glyph attribute and index data is realized by a GlyphRun and GlyphSequence.

Definition at line 36 of file glyph_attribute_packer.hpp.

Member Function Documentation

compute_needed_room()

virtual void fastuidraw::GlyphAttributePacker::compute_needed_room ( GlyphRenderer  glyph_renderer, c_array< const GlyphAttribute >  glyph_attributes, unsigned int *  out_num_indices, unsigned int *  out_num_attributes  ) const

pure virtual

To be implemented by a derived class to return how many indices and attributes are needed to realize a single glyph.

Parameters

	glyph_renderer	Glyph::renderer() of Glyph to realize
	glyph_attributes	Glyph::attributes() of Glyph to realize
[out]	out_num_indices	number of indices needed to realize the glyph
[out]	out_num_attributes	number of attributes needed to realize the glyph

glyph_position()

virtual void fastuidraw::GlyphAttributePacker::glyph_position ( Glyph  glyph, const vec2  position, float  scale_factor, vec2 *  p_bl, vec2 *  p_tr  ) const

pure virtual

To be implemented by a derived class to return the positions of the bottom-left and top-right coordinates of a glyph at the named position.

Parameters

	glyph	Glyph to realize
	position	position of bottom left of glyph
	scale_factor	the amount by which to scale from the Glyph object's coordinates
[out]	p_bl	location to which to write the bottom-left coordinate of the glyph
[out]	p_tr	location to which to write the top-right coordinate of the glyph

glyph_position_from_metrics()

virtual void fastuidraw::GlyphAttributePacker::glyph_position_from_metrics ( GlyphMetrics  metrics, const vec2  position, float  scale_factor, vec2 *  p_bl, vec2 *  p_tr  ) const

pure virtual

To be implemented by a derived class to return the positions of the bottom-left and top-right coordinates of a glyph at the named position using only the information from GlyphMetrics.

Parameters

	metrics	GlyphMertics to use to compute the bounding box
	position	position of bottom left of glyph
	scale_factor	the amount by which to scale from the Glyph object's coordinates
[out]	p_bl	location to which to write the bottom-left coordinate of the glyph
[out]	p_tr	location to which to write the top-right coordinate of the glyph

realize_attribute_data()

virtual void fastuidraw::GlyphAttributePacker::realize_attribute_data ( GlyphRenderer  glyph_renderer, c_array< const GlyphAttribute >  glyph_attributes, c_array< PainterIndex >  dst_indices, c_array< PainterAttribute >  dst_attribs, const vec2  p_bl, const vec2  p_tr  ) const

pure virtual

To be implemented by a derived class to provide the attributes and indices to realize a glyph.

Parameters

glyph_renderer	Glyph::renderer() of Glyph to realize
glyph_attributes	Glyph::attributes() of Glyph to realize
dst_indices	location to which to write the indices; the values are offsets into dst_attribs
dst_attribs	location to which to write the attributes
p_bl	position of bottom left of glyph as emited by glyph_position()
p_tr	position of top right of glyph as emited by glyph_position()

standard_packer()

static const GlyphAttributePacker& fastuidraw::GlyphAttributePacker::standard_packer ( enum PainterEnums::screen_orientation  orientation, enum PainterEnums::glyph_layout_type  layout  )

static

Returns a GlyphAttributePacker suitable for the specified PainterEnums::screen_orientation and PainterEnums::glyph_layout_type that packs each single Glyph object as exactly 4 attributes and 6 indices as follows:

• PainterAttribute::m_attrib0 .xy -> position in item coordinates of the vertex of the quad to draw the glyph (float)
• PainterAttribute::m_attrib0 .zw -> the difference in item coordinates between the bottom-left vertex position and the top-right vertex position.
• PainterAttribute::m_attrib1 .x -> Glyph::attribute()[0]
• PainterAttribute::m_attrib1 .y -> Glyph::attribute()[1]
• PainterAttribute::m_attrib1. z -> Glyph::attribute()[2]
• PainterAttribute::m_attrib1 .w -> Glyph::attribute()[3]
• PainterAttribute::m_attrib2 .x -> Glyph::attribute()[4]
• PainterAttribute::m_attrib2 .y -> Glyph::attribute()[5]
• PainterAttribute::m_attrib2 .z -> Glyph::attribute()[6]
• PainterAttribute::m_attrib2 .w -> Glyph::attribute()[7]

  Parameters

  orientation	screen orientation to use
  layout	glyph layout to use

---

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

• /home/kevin/fastuidraw.krogueintel/inc/fastuidraw/painter/attribute_data/glyph_attribute_packer.hpp