Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
cinder::dx::TextureFont::DrawOptions Struct Reference

#include <DxTextureFont.h>

Public Member Functions

 DrawOptions ()
 
bool getClipHorizontal () const
 Returns whether the output clips horizontally. More...
 
DrawOptionsclipHorizontal (bool clipH=true)
 Sets whether the output clips horizontally. More...
 
bool getClipVertical () const
 Returns whether the output clips vertically. More...
 
DrawOptionsclipVertical (bool clipV=true)
 Sets whether the output clips vertically. More...
 
bool getPixelSnap () const
 Returns whether the output glyphs are snapped to pixel boundaries. This sharpens static text but prevents subpixel animation. More...
 
DrawOptionspixelSnap (bool pixelSnap=true)
 Sets whether the output glyphs are snapped to pixel boundaries. This sharpens static text but prevents subpixel animation. More...
 
bool 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. More...
 
DrawOptionsligate (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. More...
 
float getScale () const
 Returns the scale at which the type is rendered. 2 is double size. Default 1. More...
 
DrawOptionsscale (float sc)
 Sets the scale at which the type is rendered. 2 is double size. Default 1. More...
 

Protected Attributes

bool mClipHorizontal
 
bool mClipVertical
 
bool mPixelSnap
 
bool mLigate
 
float mScale
 

Constructor & Destructor Documentation

cinder::dx::TextureFont::DrawOptions::DrawOptions ( )

Member Function Documentation

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

Returns whether the output clips horizontally.

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

Sets whether the output clips horizontally.

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

Returns whether the output clips vertically.

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

Sets whether the output clips vertically.

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

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

DrawOptions& cinder::dx::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::dx::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::dx::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::dx::TextureFont::DrawOptions::getScale ( ) const

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

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

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

Member Data Documentation

bool cinder::dx::TextureFont::DrawOptions::mClipHorizontal
protected
bool cinder::dx::TextureFont::DrawOptions::mClipVertical
protected
bool cinder::dx::TextureFont::DrawOptions::mPixelSnap
protected
bool cinder::dx::TextureFont::DrawOptions::mLigate
protected
float cinder::dx::TextureFont::DrawOptions::mScale
protected

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