AR_Engine_SDK
载入中...
搜索中...
未找到
函数 | 变量
XUILabel.lua 文件参考

#include <XUILabel.h>

类 XUILabel 继承关系图:
Inheritance graph

函数

function XUILabel CreateWithTTF () end
 
function XUILabel CreateWithTTF (ttfConfig, strUtf8Text, nLineWidth, hAlignment, vAlignment) end
 
function XUILabel CreateWithTTF (strUtf8Text, strFontFilePath, fontPointSize, nLineWidth, hAlignment, vAlignment) end
 
function XUILabel CreateWithSystemFont () end
 
function XUILabel CreateWithSystemFont (strUtf8Text, fontName, fontPointSize, hAlignment, vAlignment) end
 
function XUILabel CreateWhithImageFont (ttfConfig) end
 
function XUILabel new (hAlignment, vAlignment) end
 
function XUILabel UpdateImmediately () end
 
function XUILabel SetTextPointSize (fPointSize) end
 
function XUILabel GetTextPointSize () end
 
function XUILabel SetEnableWrap (bEnableWrap) end
 
function XUILabel GetEnableWrap () end
 
function XUILabel SetString (strUtf8Text) end
 
function XUILabel GetString () end
 
function XUILabel GetStringCount () end
 
function XUILabel SetAlignment (hAlign, vAlign) end
 
function XUILabel SetHAlignMent (hAlign) end
 
function XUILabel SetVAlignMent (vAlign) end
 
function XUILabel GetHAlignment () end
 
function XUILabel GetVAlignment () end
 
function XUILabel SetDimensions (fWidth, fHeight) end
 
function XUILabel GetDimensions () end
 
function XUILabel SetTextColor (clr) end
 
function XUILabel GetTextColor () end
 
function XUILabel SetTextUpperColor (clr) end
 
function XUILabel GetTextUpperColor () end
 
function XUILabel SetTextLowerColor (clr) end
 
function XUILabel GetTextLowerColor () end
 
function XUILabel SetOutlineColor (clrOutLine) end
 
function XUILabel GetOutlineColor () end
 
function XUILabel SetOutlineSize (nOutlineSize) end
 
function XUILabel GetOutlineSize () end
 
function XUILabel SetAdditionalKerning (fAdditionalKerning) end
 
function XUILabel GetAdditionalKerning () end
 
function XUILabel SetLineSpacing (fLineSpacing) end
 
function XUILabel GetLineSpacing () end
 
function XUILabel SetTTFFontPath (strPath) end
 
function XUILabel GetTTFFontPath () end
 
function XUILabel SetFontPath (strPath) end
 
function XUILabel GetFontPath () end
 
function XUILabel SetPListPath (strPath) end
 
function XUILabel GetImgFontPath () end
 
function XUILabel SetBreakOfWesternWord (bBreakOfWesternWord) end
 
function XUILabel GetBreakOfWesternWord () end
 
function XUILabel ChangeToSystemFont () end
 
function XUILabel SetSystemFontName (strFontName) end
 
function XUILabel GetSystemFontName () end
 
function XUILabel GetLabelType () end
 
function XUILabel SetLabelType (type) end
 
function XUILabel SetRichText (tichtext) end
 
function XUILabel SetTextFormat (_format) end
 
function XUILabel GetFontTextures () end
 

变量

 XUILabel = {}
 
XUILabel XUIL_TTF = 0
 
XUILabel XUIL_SYSTEMF = 0
 
XUILabel XUIL_IMAGE = 0
 

函数说明

◆ ChangeToSystemFont()

function XUILabel ChangeToSystemFont ( )

切换到系统字体

返回
void

◆ CreateWhithImageFont()

function XUILabel CreateWhithImageFont ( ttfConfig  )

XUILabel_CreateWhithImageFont00

参数
ttfConfigXUIIMFConfig
返回
XUILabel

◆ CreateWithSystemFont() [1/2]

function XUILabel CreateWithSystemFont ( )

基于平台相关的API创建一个默认的文本

返回
XUILabel 返回创建的Label指针

◆ CreateWithSystemFont() [2/2]

function XUILabel CreateWithSystemFont ( strUtf8Text  ,
fontName  ,
fontPointSize  ,
hAlignment  ,
vAlignment   
)

基于平台相关的API创建和初始化一个文本

参数
strUtf8Textstring 最初文本内容
fontNamestring 一个字体文件或字体名称
fontPointSizenumber 字体大小，这个值必须大于0
hAlignmentnumber 水平对齐方式
vAlignmentnumber 水平对齐方式
返回
XUILabel 返回创建的Label指针

◆ CreateWithTTF() [1/3]

function XUILabel CreateWithTTF ( )

使用默认设置分配和初始化一个文本

返回
XUILabel 控件指针

◆ CreateWithTTF() [2/3]

function XUILabel CreateWithTTF ( strUtf8Text  ,
strFontFilePath  ,
fontPointSize  ,
nLineWidth  ,
hAlignment  ,
vAlignment   
)

使用FreeType2库创建和初始化一个文本

参数
strUtf8Textstring 最初文本内容
strFontFilePathstring 一个TTF字体文件
fontPointSizenumber 字体大小，这个值必须大于0
nLineWidthnumber 线宽
hAlignmentnumber 水平对齐方式
vAlignmentnumber 水平对齐方式
返回
XUILabel 返回创建的Label指针

◆ CreateWithTTF() [3/3]

function XUILabel CreateWithTTF ( ttfConfig  ,
strUtf8Text  ,
nLineWidth  ,
hAlignment  ,
vAlignment   
)

使用FreeType2库创建和初始化一个文本

参数
ttfConfigXUITTFConfig ttf信息
strUtf8Textstring 最初文本内容
nLineWidthnumber 线宽
hAlignmentnumber 水平对齐方式
vAlignmentnumber 水平对齐方式
返回
XUILabel 返回创建的Label指针

◆ GetAdditionalKerning()

function XUILabel GetAdditionalKerning ( )

XUILabel_GetAdditionalKerning00

返回
number

◆ GetBreakOfWesternWord()

function XUILabel GetBreakOfWesternWord ( )

XUILabel_GetBreakOfWesternWord00

返回
boolean

◆ GetDimensions()

function XUILabel GetDimensions ( )

获取文本区域

返回
XVECTOR2

◆ GetEnableWrap()

function XUILabel GetEnableWrap ( )

XUILabel_GetEnableWrap00

返回
boolean

◆ GetFontPath()

function XUILabel GetFontPath ( )

XUILabel_GetFontPath00

返回
string

◆ GetFontTextures()

function XUILabel GetFontTextures ( )

XUILabel_GetFontTextures00

返回
IXTexture2D[]

◆ GetHAlignment()

function XUILabel GetHAlignment ( )

XUILabel_GetHAlignment00

返回
number

◆ GetImgFontPath()

function XUILabel GetImgFontPath ( )

XUILabel_GetImgFontPath00

返回
string

◆ GetLabelType()

function XUILabel GetLabelType ( )

XUILabel_GetLabelType00

返回
number

◆ GetLineSpacing()

function XUILabel GetLineSpacing ( )

XUILabel_GetLineSpacing00

返回
number

◆ GetOutlineColor()

function XUILabel GetOutlineColor ( )

XUILabel_GetOutlineColor00

返回
XCOLORBASE

◆ GetOutlineSize()

function XUILabel GetOutlineSize ( )

XUILabel_GetOutlineSize00

返回
number

◆ GetString()

function XUILabel GetString ( )

获取文本内容

返回
string

◆ GetStringCount()

function XUILabel GetStringCount ( )

获取文本大小

返回
number

◆ GetSystemFontName()

function XUILabel GetSystemFontName ( )

XUILabel_GetSystemFontName00

返回
string

◆ GetTextColor()

function XUILabel GetTextColor ( )

XUILabel_GetTextColor00

返回
XCOLORBASE

◆ GetTextLowerColor()

function XUILabel GetTextLowerColor ( )

XUILabel_GetTextLowerColor00

返回
XCOLORBASE

◆ GetTextPointSize()

function XUILabel GetTextPointSize ( )

XUILabel_GetTextPointSize00

返回
number

◆ GetTextUpperColor()

function XUILabel GetTextUpperColor ( )

XUILabel_GetTextUpperColor00

返回
XCOLORBASE

◆ GetTTFFontPath()

function XUILabel GetTTFFontPath ( )

XUILabel_GetTTFFontPath00

返回
string

◆ GetVAlignment()

function XUILabel GetVAlignment ( )

XUILabel_GetVAlignment00

返回
number

◆ new()

function XUILabel new ( hAlignment  ,
vAlignment   
)

XUILabel_new00

参数
hAlignmentnumber
vAlignmentnumber
返回
XUILabel

◆ SetAdditionalKerning()

function XUILabel SetAdditionalKerning ( fAdditionalKerning  )

获取文本描边宽度 设置文本的字间距, 仅TTF文字支持

参数
fAdditionalKerningnumber 字间距值
返回
void 返回描边颜色

◆ SetAlignment()

function XUILabel SetAlignment ( hAlign  ,
vAlign   
)

设置文本对齐方式

参数
hAlignnumber 水平对齐
vAlignnumber 竖直对齐
返回
void

◆ SetBreakOfWesternWord()

function XUILabel SetBreakOfWesternWord ( bBreakOfWesternWord  )

设置是否允许在西文单词中换行, 仅TTF文字支持

参数
bBreakOfWesternWordboolean 是否在西文中换行
返回
void

◆ SetDimensions()

function XUILabel SetDimensions ( fWidth  ,
fHeight   
)

设置文本区域 即Label的宽度和高度，按文字行最大宽度和高度自动调整

参数
fWidthnumber
fHeightnumber 高度当fHeight>0.0，且文字总高度超出fHeight，则截断文字。fWidth或fHeight为小于等于0.0，则表示大小自动适应。
返回
void

◆ SetEnableWrap()

function XUILabel SetEnableWrap ( bEnableWrap  )

设置是否自动换行

参数
bEnableWrapboolean 默认true，为false时，要求m_fLabelWidth>0.0f，才会进行自动换行处理。
返回
void

◆ SetFontPath()

function XUILabel SetFontPath ( strPath  )

XUILabel_SetFontPath00

参数
strPathstring
返回
void

◆ SetHAlignMent()

function XUILabel SetHAlignMent ( hAlign  )

设置文本水平对齐方式

参数
hAlignnumber 水平对齐
返回
void

◆ SetLabelType()

function XUILabel SetLabelType ( type  )

XUILabel_SetLabelType00

参数
typenumber
返回
void

◆ SetLineSpacing()

function XUILabel SetLineSpacing ( fLineSpacing  )

设置文本的行间距, 仅TTF文字支持

参数
fLineSpacingnumber
返回
void

◆ SetOutlineColor()

function XUILabel SetOutlineColor ( clrOutLine  )

设置文本描边颜色

参数
clrOutLineXCOLORBASE 描边颜色
返回
void

◆ SetOutlineSize()

function XUILabel SetOutlineSize ( nOutlineSize  )

设置文本描边宽度

参数
nOutlineSizenumber
返回
void

◆ SetPListPath()

function XUILabel SetPListPath ( strPath  )

XUILabel_SetPListPath00

参数
strPathstring
返回
void

◆ SetRichText()

function XUILabel SetRichText ( tichtext  )

XUILabel_SetRichText00

参数
tichtextstring
返回
void

◆ SetString()

function XUILabel SetString ( strUtf8Text  )

@manual 设置文本内容 手动导出 增加扩展，支持传入任何类型 XUILabel_SetString_manual

参数
strUtf8Textstring
返回
void

◆ SetSystemFontName()

function XUILabel SetSystemFontName ( strFontName  )

设置系统字体名称

参数
strFontNamestring 系统字体名称
返回
void

◆ SetTextColor()

function XUILabel SetTextColor ( clr  )

设置文本颜色

参数
clrXCOLORBASE 文本颜色
返回
void

◆ SetTextFormat()

function XUILabel SetTextFormat ( _format  )

XUILabel_SetTextFormat00

参数
_formatXUITextFormat
返回
void

◆ SetTextLowerColor()

function XUILabel SetTextLowerColor ( clr  )

设置文本渐变颜色-下层颜色

参数
clrXCOLORBASE 文本下层颜色
返回
void

◆ SetTextPointSize()

function XUILabel SetTextPointSize ( fPointSize  )

设置字体大小

参数
fPointSizenumber
返回
void

◆ SetTextUpperColor()

function XUILabel SetTextUpperColor ( clr  )

设置文本渐变颜色-上层颜色

参数
clrXCOLORBASE 文本上层颜色
返回
void

◆ SetTTFFontPath()

function XUILabel SetTTFFontPath ( strPath  )

更改字体

参数
strPathstring
返回
void

◆ SetVAlignMent()

function XUILabel SetVAlignMent ( vAlign  )

设置文本垂直对齐方式

参数
vAlignnumber 垂直对齐
返回
void

◆ UpdateImmediately()

function XUILabel UpdateImmediately ( )

应用设置

返回
void

变量说明

◆ XUIL_IMAGE

XUILabel XUIL_IMAGE = 0

◆ XUIL_SYSTEMF

XUILabel XUIL_SYSTEMF = 0

◆ XUIL_TTF

XUILabel XUIL_TTF = 0

◆ XUILabel

XUILabel = {}
制作者 doxygen 1.9.6