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

函数

function XMaterialParamTypeValue new () end
 @type string
 
function XMaterialParamTypeValue new (xValue) end
 
function XMaterialParamTypeValue new (vec1Val) end
 
function XMaterialParamTypeValue new (vec2Val) end
 
function XMaterialParamTypeValue new (vec3Val) end
 
function XMaterialParamTypeValue new (vec4Val) end
 
function XMaterialParamTypeValue new (vec16Val) end
 
function XMaterialParamTypeValue new (pTexture2D) end
 
function XMaterialParamTypeValue new (pTextureCube) end
 
function XMaterialParamDescInfo__XAnnotation new (other) end
 
function IXMaterial Release () end
 
function IXMaterial GetMaterialFileName () end
 
function IXMaterial GetPassNum () end
 
function IXMaterial GetRenderLayerSortValue () end
 
function IXMaterial IsEnableCastShadow () end
 
function IXMaterial IsEnableDepthTest (nPassIndex) end
 
function IXMaterial IsEnableDepthWrite (nPassIndex) end
 
function IXMaterial IsEnableTwoSidedShow (nPassIndex) end
 
function IXMaterial GetMaterialPassDescInfo (nPassIndex) end
 
function IXMaterial GetMatShaderDescInfo (nPassIndex) end
 
function IXMaterial GetMatParamCount () end
 
function IXMaterial GetMatParamDescInfoByParamName (szName) end
 
function IXMaterial GetMatParamDescInfoByParamId (id) end
 
function IXMaterial GetMatParamIdByParamName (szName) end
 
function IXMaterial GetSupportMacroCount () end
 
function IXMaterial GetSupportMacroById (id) end
 
function IXMaterialInstance GetMaterialPtr () end
 
function IXMaterialInstance GetMaterialInsFile () end
 
function IXMaterialInstance GetParameterCount () end
 
function IXMaterialInstance GetParameterDescInfoByParamName (szName) end
 
function IXMaterialInstance GetParameterDescInfoByParamId (id) end
 
function IXMaterialInstance GetParameterIdByParamName (szName) end
 
function IXMaterialInstance GetParameterByParamId (iId) end
 
function IXMaterialInstance GetParameterByParamName (szName) end
 
function IXMaterialInstance SetParameterByParamName (szName, val) end
 
function IXMaterialInstance SetParameterByParamId (id, val) end
 
function IXMaterialInstance SetTextureParameterByParamName (szName, pTexture) end
 
function IXMaterialInstance SetTextureParameterByParamId (id, pTexture) end
 
function IXMaterialInstance IsMacroEnabled (id) end
 
function IXMaterialInstance EnabledMacro (id, bEnable) end
 
function IXMaterialInstance ChangeMtl (szMaterialFile) end
 
function IXMaterialInstance ApplyAndUpdateMaterial (pSrcMtlIns) end
 
function IXMaterialInstance IsCastShadow () end
 
function IXMaterialManager Init () end
 
function IXMaterialManager SaveMaterial (pMaterial, szFileName, bBinary, bSaveToMinSupportVersion) end
 
function IXMaterialManager GetMaterial (szMaterialFileName, szReplaceShaderMacro, bBinary, bReload) end
 
function IXMaterialManager SaveMaterialInstance (szSaveMatInsFile, szMatFile, szShaderMacro, aParams, bBinary) end
 @type number
 
function IXMaterialManager GetMaterialInstance (szMaterialInsFileName, szReplaceShaderMacro, bReLoad, bBinary, bBinaryMaterialFile) end
 
function IXMaterialManager CreateMaterialInstance (szNewMaterialInsFile, szMaterialFile, szReplaceShaderMacro, bBinaryMaterialFile) end
 
function IXMaterialManager ReloadMaterialInstance (szMaterialInsFile) end
 
function IXMaterialManager IsMaterialInstanceExist (szMtlInsFile, szReplaceShaderMacro) end
 
function IXMaterialManager IsMaterialInstanceLoaded (szMtlInsFile, szReplaceShaderMacro) end
 

变量

 XMDT_UNKNOWN = 0
 
 XMDT_FLOAT = 0
 
 XMDT_FLOAT2 = 0
 
 XMDT_FLOAT3 = 0
 
 XMDT_FLOAT4 = 0
 
 XMDT_FLOAT_ALL = 0
 
 XMDT_MATRIX4 = 0
 
 XMDT_MATRIX4_ARRAY = 0
 
 XMDT_2DTEX = 0
 
 XMDT_NOTSUPPORT3DTEX = 0
 
 XMDT_CUBETEX = 0
 
 XMDT_ALL_TEX = 0
 
 XMDT_FLOAT4_ARRAY = 0
 
 XMDT_FLOAT3_ARRAY = 0
 
 XMDT_FLOAT2_ARRAY = 0
 
 XMDT_FLOAT_ARRAY = 0
 
 XMDT_FLOAT_ARRAY_ALL = 0
 
 XMDT_PASS_SCOPE = 0
 
 XMaterialParamTypeValue = {}
 

函数说明

◆ ApplyAndUpdateMaterial()

function IXMaterialInstance ApplyAndUpdateMaterial ( pSrcMtlIns  )

应用其他材质实例的参数到本材质实例

参数
pSrcMtlInsIXMaterialInstance 应用的材质实例对象
返回
boolean 是否执行成功

◆ ChangeMtl()

function IXMaterialInstance ChangeMtl ( szMaterialFile  )

切换材质模板

参数
szMaterialFilestring 材质模板文件名
返回
boolean 是否切换成功

◆ CreateMaterialInstance()

function IXMaterialManager CreateMaterialInstance ( szNewMaterialInsFile  ,
szMaterialFile  ,
szReplaceShaderMacro  ,
bBinaryMaterialFile   
)

创建一个内存中的材质实例，材质实例名称和宏连接起来的字符串作为key

参数
szNewMaterialInsFilestring
szMaterialFilestring
szReplaceShaderMacrostring
bBinaryMaterialFileboolean
返回
IXMaterialInstance

◆ EnabledMacro()

function IXMaterialInstance EnabledMacro ( id  ,
bEnable   
)

设置是否启用某个材质参数宏id

参数
idnumber 材质参数宏id
bEnableboolean 是否启用
返回
void

◆ GetMaterial()

function IXMaterialManager GetMaterial ( szMaterialFileName  ,
szReplaceShaderMacro  ,
bBinary  ,
bReload   
)

获取一个内存中或硬盘上的材质，IXMaterial引用计数+1

参数
szMaterialFileNamestring
szReplaceShaderMacrostring
bBinaryboolean
bReloadboolean
返回
IXMaterial

◆ GetMaterialFileName()

function IXMaterial GetMaterialFileName ( )

获取材质资源文件名

返回
string 材质资源文件名

◆ GetMaterialInsFile()

function IXMaterialInstance GetMaterialInsFile ( )

获取材质实例文件名

返回
string 材质实例文件名

◆ GetMaterialInstance()

function IXMaterialManager GetMaterialInstance ( szMaterialInsFileName  ,
szReplaceShaderMacro  ,
bReLoad  ,
bBinary  ,
bBinaryMaterialFile   
)

获取一个内存中或硬盘上的材质实例，IXMaterialInstance引用计数+1

参数
szMaterialInsFileNamestring
szReplaceShaderMacrostring
bReLoadboolean
bBinaryboolean
bBinaryMaterialFileboolean
返回
IXMaterialInstance

◆ GetMaterialPassDescInfo()

function IXMaterial GetMaterialPassDescInfo ( nPassIndex  )

IXMaterial_GetMaterialPassDescInfo00

参数
nPassIndexnumber
返回
XMaterialPassDescInfo

IXMaterial_GetMaterialPassDescInfo01

参数
nPassIndexnumber
返回
XMaterialPassDescInfo

◆ GetMaterialPtr()

function IXMaterialInstance GetMaterialPtr ( )

获取材质指针

返回
IXMaterial 材质指针

◆ GetMatParamCount()

function IXMaterial GetMatParamCount ( )

获取材质参数个数

返回
number 材质参数个数

◆ GetMatParamDescInfoByParamId()

function IXMaterial GetMatParamDescInfoByParamId ( id  )

根据材质参数id获取材质参数信息描述结构体

参数
idnumber 材质参数id
返回
XMaterialParamDescInfo 材质参数信息描述结构体

◆ GetMatParamDescInfoByParamName()

function IXMaterial GetMatParamDescInfoByParamName ( szName  )

根据材质参数名获取材质参数信息描述结构体

参数
szNamestring 材质参数名
返回
XMaterialParamDescInfo 材质参数信息描述结构体

◆ GetMatParamIdByParamName()

function IXMaterial GetMatParamIdByParamName ( szName  )

根据材质参数名获取材质参数id

参数
szNamestring 材质参数名
返回
number 材质参数id

◆ GetMatShaderDescInfo()

function IXMaterial GetMatShaderDescInfo ( nPassIndex  )

IXMaterial_GetMatShaderDescInfo00

参数
nPassIndexnumber
返回
XMaterialShaderDescInfo

◆ GetParameterByParamId()

function IXMaterialInstance GetParameterByParamId ( iId  )

根据材质参数id获取材质参数信息

参数
iIdnumber 材质参数id
返回
XMaterialParamTypeValue 材质参数信息

◆ GetParameterByParamName()

function IXMaterialInstance GetParameterByParamName ( szName  )

根据材质参数名获取材质参数信息

参数
szNamestring 材质参数名
返回
XMaterialParamTypeValue 材质参数信息

◆ GetParameterCount()

function IXMaterialInstance GetParameterCount ( )

获取材质参数总个数

返回
number 材质参数总个数

◆ GetParameterDescInfoByParamId()

function IXMaterialInstance GetParameterDescInfoByParamId ( id  )

根据材质参数id获取材质参数信息描述结构体

参数
idnumber 材质参数id
返回
XMaterialParamDescInfo 材质参数信息描述结构体

◆ GetParameterDescInfoByParamName()

function IXMaterialInstance GetParameterDescInfoByParamName ( szName  )

根据材质参数名获取材质参数信息描述结构体

参数
szNamestring 材质参数名
返回
XMaterialParamDescInfo 材质参数信息描述结构体

◆ GetParameterIdByParamName()

function IXMaterialInstance GetParameterIdByParamName ( szName  )

根据材质参数名获取材质参数id

参数
szNamestring 材质参数名
返回
number 材质参数id

◆ GetPassNum()

function IXMaterial GetPassNum ( )

IXMaterial_GetPassNum00

返回
number

◆ GetRenderLayerSortValue()

function IXMaterial GetRenderLayerSortValue ( )

IXMaterial_GetRenderLayerSortValue00

返回
number

◆ GetSupportMacroById()

function IXMaterial GetSupportMacroById ( id  )

根据id获取对应材质宏信息

参数
idnumber 宏id
返回
XMaterialSupportMacro 对应材质宏信息

◆ GetSupportMacroCount()

function IXMaterial GetSupportMacroCount ( )

获取支持的材质宏的个数

返回
number 支持的材质宏的个数

◆ Init()

function IXMaterialManager Init ( )

初始化

返回
boolean 是否初始化成功

◆ IsCastShadow()

function IXMaterialInstance IsCastShadow ( )

是否投射阴影

返回
boolean 是否投射阴影

◆ IsEnableCastShadow()

function IXMaterial IsEnableCastShadow ( )

IXMaterial_IsEnableCastShadow00

返回
boolean

◆ IsEnableDepthTest()

function IXMaterial IsEnableDepthTest ( nPassIndex  )

IXMaterial_IsEnableDepthTest00

参数
nPassIndexnumber
返回
boolean

◆ IsEnableDepthWrite()

function IXMaterial IsEnableDepthWrite ( nPassIndex  )

IXMaterial_IsEnableDepthWrite00

参数
nPassIndexnumber
返回
boolean

◆ IsEnableTwoSidedShow()

function IXMaterial IsEnableTwoSidedShow ( nPassIndex  )

IXMaterial_IsEnableTwoSidedShow00

参数
nPassIndexnumber
返回
boolean

◆ IsMacroEnabled()

function IXMaterialInstance IsMacroEnabled ( id  )

判断是否启用了某个宏

参数
idnumber 材质宏id
返回
boolean 是否启用

◆ IsMaterialInstanceExist()

function IXMaterialManager IsMaterialInstanceExist ( szMtlInsFile  ,
szReplaceShaderMacro   
)

判断材质实例是否存在(内存+硬盘)

参数
szMtlInsFilestring
szReplaceShaderMacrostring
返回
boolean 材质实例是否存在

◆ IsMaterialInstanceLoaded()

function IXMaterialManager IsMaterialInstanceLoaded ( szMtlInsFile  ,
szReplaceShaderMacro   
)

判断材质实例是否已加载

参数
szMtlInsFilestring
szReplaceShaderMacrostring
返回
boolean 材质实例是否已加载

◆ new() [1/10]

function XMaterialParamTypeValue new ( )

@type string

XMaterialParamTypeValue_new00

返回
XMaterialParamTypeValue

@type number @type string XMaterialParamDescInfo_XAnnotation_new00

返回
XMaterialParamDescInfo__XAnnotation

@type number @type string @type number XMaterialSupportMacro_new00

返回
XMaterialSupportMacro

◆ new() [2/10]

function XMaterialParamDescInfo__XAnnotation new ( other  )

XMaterialParamDescInfo_XAnnotation_new01

参数
otherXMaterialParamDescInfo::XAnnotation
返回
XMaterialParamDescInfo__XAnnotation

◆ new() [3/10]

function XMaterialParamTypeValue new ( pTexture2D  )

XMaterialParamTypeValue_new08

参数
pTexture2DIXTexture2D
返回
XMaterialParamTypeValue

◆ new() [4/10]

function XMaterialParamTypeValue new ( pTextureCube  )

XMaterialParamTypeValue_new09

参数
pTextureCubeIXTextureCube
返回
XMaterialParamTypeValue

◆ new() [5/10]

function XMaterialParamTypeValue new ( vec16Val  )

XMaterialParamTypeValue_new07

参数
vec16ValXMATRIX4
返回
XMaterialParamTypeValue

◆ new() [6/10]

function XMaterialParamTypeValue new ( vec1Val  )

XMaterialParamTypeValue_new02

参数
vec1Valnumber
返回
XMaterialParamTypeValue

◆ new() [7/10]

function XMaterialParamTypeValue new ( vec2Val  )

XMaterialParamTypeValue_new03

参数
vec2ValXVECTOR2
返回
XMaterialParamTypeValue

◆ new() [8/10]

function XMaterialParamTypeValue new ( vec3Val  )

XMaterialParamTypeValue_new04

参数
vec3ValXVECTOR3
返回
XMaterialParamTypeValue

◆ new() [9/10]

function XMaterialParamTypeValue new ( vec4Val  )

XMaterialParamTypeValue_new05

参数
vec4ValXVECTOR4
返回
XMaterialParamTypeValue

XMaterialParamTypeValue_new06

参数
vec4ValXCOLORBASE
返回
XMaterialParamTypeValue

◆ new() [10/10]

function XMaterialParamTypeValue new ( xValue  )

XMaterialParamTypeValue_new01

参数
xValueXMaterialParamTypeValue
返回
XMaterialParamTypeValue

◆ Release()

function IXMaterial Release ( )

释放信息

返回
void

◆ ReloadMaterialInstance()

function IXMaterialManager ReloadMaterialInstance ( szMaterialInsFile  )

重新加载材质实例

参数
szMaterialInsFilestring 材质文件名
返回
void

◆ SaveMaterial()

function IXMaterialManager SaveMaterial ( pMaterial  ,
szFileName  ,
bBinary  ,
bSaveToMinSupportVersion   
)

保存材质文件

参数
pMaterialIXMaterial
szFileNamestring
bBinaryboolean
bSaveToMinSupportVersionboolean
返回
void

◆ SaveMaterialInstance()

function IXMaterialManager SaveMaterialInstance ( szSaveMatInsFile  ,
szMatFile  ,
szShaderMacro  ,
aParams  ,
bBinary   
)

@type number

@type string @type string @type boolean @type XVECTOR4 保存材质实例

参数
szSaveMatInsFilestring 材质实例文件名
szMatFilestring
szShaderMacrostring
aParamsXMaterialInsParameterForSave[]
bBinaryboolean
返回
void

◆ SetParameterByParamId()

function IXMaterialInstance SetParameterByParamId ( id  ,
val   
)

根据材质参数id设置材质参数信息

参数
idnumber 材质参数id
valXMaterialParamTypeValue 材质参数信息
返回
void

◆ SetParameterByParamName()

function IXMaterialInstance SetParameterByParamName ( szName  ,
val   
)

根据材质参数名设置材质参数信息

参数
szNamestring 材质参数名
valXMaterialParamTypeValue 材质参数信息
返回
void

◆ SetTextureParameterByParamId()

function IXMaterialInstance SetTextureParameterByParamId ( id  ,
pTexture   
)

根据材质参数id设置材质纹理参数

参数
idnumber 材质参数id
pTextureIXTexture 材质纹理参数对象
返回
void

◆ SetTextureParameterByParamName()

function IXMaterialInstance SetTextureParameterByParamName ( szName  ,
pTexture   
)

根据材质参数名设置材质纹理参数

参数
szNamestring 材质参数名
pTextureIXTexture 材质纹理参数对象
返回
void

变量说明

◆ XMaterialParamTypeValue

XMaterialParamTypeValue = {}

◆ XMDT_2DTEX

XMDT_2DTEX = 0

◆ XMDT_ALL_TEX

XMDT_ALL_TEX = 0

◆ XMDT_CUBETEX

XMDT_CUBETEX = 0

◆ XMDT_FLOAT

XMDT_FLOAT = 0

◆ XMDT_FLOAT2

XMDT_FLOAT2 = 0

◆ XMDT_FLOAT2_ARRAY

XMDT_FLOAT2_ARRAY = 0

◆ XMDT_FLOAT3

XMDT_FLOAT3 = 0

◆ XMDT_FLOAT3_ARRAY

XMDT_FLOAT3_ARRAY = 0

◆ XMDT_FLOAT4

XMDT_FLOAT4 = 0

◆ XMDT_FLOAT4_ARRAY

XMDT_FLOAT4_ARRAY = 0

◆ XMDT_FLOAT_ALL

XMDT_FLOAT_ALL = 0

◆ XMDT_FLOAT_ARRAY

XMDT_FLOAT_ARRAY = 0

◆ XMDT_FLOAT_ARRAY_ALL

XMDT_FLOAT_ARRAY_ALL = 0

◆ XMDT_MATRIX4

XMDT_MATRIX4 = 0

◆ XMDT_MATRIX4_ARRAY

XMDT_MATRIX4_ARRAY = 0

◆ XMDT_NOTSUPPORT3DTEX

XMDT_NOTSUPPORT3DTEX = 0

◆ XMDT_PASS_SCOPE

XMDT_PASS_SCOPE = 0

◆ XMDT_UNKNOWN

XMDT_UNKNOWN = 0
制作者 doxygen 1.9.6