nCine

• Index

Contents

• Functions
• Tables

Modules

• ncine
• ncine.animated_sprite
• ncine.app_configuration
• ncine.application
• ncine.audio_buffer
• ncine.audio_buffer_player
• ncine.audio_device
• ncine.audio_effect
• ncine.audio_effect_properties
• ncine.audio_effect_slot
• ncine.audio_filter
• ncine.audio_player
• ncine.audio_stream_player
• ncine.base_sprite
• ncine.camera
• ncine.color
• ncine.drawable_node
• EFX_Presets
• ncine.font
• ncine.frame_timer
• ncine.fs
• ncine.gfx_device
• ncine.hash64
• ncine.input
• ncine.keys
• ncine.log
• ncine.mesh_sprite
• ncinelua
• ncine.particle_affector
• ncine.particle_system
• ncine.rect
• ncine.scenenode
• ncine.shader
• ncine.shaderstate
• ncine.sprite
• ncine.textnode
• ncine.texture
• ncine.timestamp
• ncine.vec2
• ncine.vec3
• ncine.vec4
• ncine.viewport

Topics

• readme

Module ncine.font

The table containing font related functions

Functions

ncine.font.new (fnt_file, texture_file)	Constructs the font object from an AngelCode’s FNT file and a texture file.
ncine.font.delete (font)	Destroys a font object and releases its memory
ncine.font.get_texture (font)	Returns the texture object in use by the font
ncine.font.set_texture (font, texture)	Sets a new shared texture object without modifying any glyphs or kerning data
ncine.font.get_line_height (font)	Returns the font line height
ncine.font.get_base (font)	Returns the font base
ncine.font.get_texture_size (font)	Returns the texture atlas size
ncine.font.num_glyphs (font)	Returns the number of glyphs
ncine.font.num_kernings (font)	Returns the number of kerning pairs
ncine.font.get_render_mode (font)	Returns the mode detected by the font to render text nodes

Tables

fontObj	The light user data of a font object
ncine.font_render_mode	Font rendering modes (enumeration)

Functions

ncine.font.new (fnt_file, texture_file)

Constructs the font object from an AngelCode’s FNT file and a texture file.

If the texture_file parameter is an empty string, then a texture with the same name as the FNT file is searched in the same path.

Don’t forget to call ncine.font.delete when you are done with it!

Parameters:

• fnt_file string The path to a FNT file
• texture_file string The path to a texture file

Returns:

fontObj A new font object

ncine.font.delete (font)

Destroys a font object and releases its memory

Parameters:

• font fontObj The font object to be destroyed

ncine.font.get_texture (font)

Returns the texture object in use by the font

Parameters:

• font fontObj

Returns:

ncine.texture.textureObj or nil

ncine.font.set_texture (font, texture)

Sets a new shared texture object without modifying any glyphs or kerning data

Parameters:

• font fontObj
• texture ncine.texture.textureObj or nil

ncine.font.get_line_height (font)

Returns the font line height

Parameters:

• font fontObj

Returns:

integer

ncine.font.get_base (font)

Returns the font base

Parameters:

• font fontObj

Returns:

integer

ncine.font.get_texture_size (font)

Returns the texture atlas size

Parameters:

• font fontObj

Returns:

ncine.vec2

ncine.font.num_glyphs (font)

Returns the number of glyphs

Parameters:

• font fontObj

Returns:

integer

ncine.font.num_kernings (font)

Returns the number of kerning pairs

Parameters:

• font fontObj

Returns:

integer

ncine.font.get_render_mode (font)

Returns the mode detected by the font to render text nodes

Parameters:

• font fontObj

Returns:

ncine.font_render_mode

Tables

fontObj

The light user data of a font object

ncine.font_render_mode

Font rendering modes (enumeration)

Fields:

• GLYPH_IN_ALPHA
• GLYPH_IN_RED
• GLYPH_SPRITE