Cinder  0.9.1
Public Member Functions | Protected Attributes | List of all members
cinder::gl::TextureFont::DrawOptions Struct Reference

#include <TextureFont.h>

Public Member Functions

 DrawOptions ()
 
bool getClipHorizontal () const
 
DrawOptionsclipHorizontal (bool clipH=true)
 
bool getClipVertical () const
 
DrawOptionsclipVertical (bool clipV=true)
 
bool getPixelSnap () const
 
DrawOptionspixelSnap (bool pixelSnap=true)
 
bool getLigate () const
 
DrawOptionsligate (bool useLigatures=true)
 
float getScale () const
 
DrawOptionsscale (float sc)
 
const GlslProgRefgetGlslProg () const
 
DrawOptionsglslProg (const GlslProgRef &glslProg)
 

Protected Attributes

bool mClipHorizontal
 
bool mClipVertical
 
bool mPixelSnap
 
bool mLigate
 
float mScale
 
GlslProgRef mGlslProg
 

Constructor & Destructor Documentation

cinder::gl::TextureFont::DrawOptions::DrawOptions ( )

Member Function Documentation

bool cinder::gl::TextureFont::DrawOptions::getClipHorizontal ( ) const

Returns whether the output clips horizontally.

DrawOptions& cinder::gl::TextureFont::DrawOptions::clipHorizontal ( bool  clipH = true)

Sets whether the output clips horizontally.

bool cinder::gl::TextureFont::DrawOptions::getClipVertical ( ) const

Returns whether the output clips vertically.

DrawOptions& cinder::gl::TextureFont::DrawOptions::clipVertical ( bool  clipV = true)

Sets whether the output clips vertically.

bool cinder::gl::TextureFont::DrawOptions::getPixelSnap ( ) const

Returns whether the output glyphs are snapped to pixel boundaries. This sharpens static text but prevents subpixel animation.

DrawOptions& cinder::gl::TextureFont::DrawOptions::pixelSnap ( bool  pixelSnap = true)

Sets whether the output glyphs are snapped to pixel boundaries. This sharpens static text but prevents subpixel animation.

bool cinder::gl::TextureFont::DrawOptions::getLigate ( ) const

Returns whether advanced ligatures are used, which must have been instantiated by the supportedChars parameter of the TextureFont::create() call. Default to false.

DrawOptions& cinder::gl::TextureFont::DrawOptions::ligate ( bool  useLigatures = true)

Sets whether advanced ligatures are used, which must have been instantiated by the supportedChars parameter of the TextureFont::create() call. Default to false.

float cinder::gl::TextureFont::DrawOptions::getScale ( ) const

Returns the scale at which the type is rendered. 2 is double size. Default 1.

DrawOptions& cinder::gl::TextureFont::DrawOptions::scale ( float  sc)

Sets the scale at which the type is rendered. 2 is double size. Default 1.

const GlslProgRef& cinder::gl::TextureFont::DrawOptions::getGlslProg ( ) const

Returns the user-specified glsl program if set. Otherwise returns nullptr.

DrawOptions& cinder::gl::TextureFont::DrawOptions::glslProg ( const GlslProgRef glslProg)

Sets a custom shader to use when the type is rendered.

Member Data Documentation

bool cinder::gl::TextureFont::DrawOptions::mClipHorizontal
protected
bool cinder::gl::TextureFont::DrawOptions::mClipVertical
protected
bool cinder::gl::TextureFont::DrawOptions::mPixelSnap
protected
bool cinder::gl::TextureFont::DrawOptions::mLigate
protected
float cinder::gl::TextureFont::DrawOptions::mScale
protected
GlslProgRef cinder::gl::TextureFont::DrawOptions::mGlslProg
protected

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