程序包 ohos.agp.render.render3d.resources

类 MaterialDesc

java.lang.Object

ohos.agp.render.render3d.resources.MaterialDesc

public class MaterialDesc
extends Object

Describes properties of a material.

Materials can be assigned to objects that are rendered using resource handles. For details, see ResourceManager.

从以下版本开始:

3

嵌套类概要

嵌套类

限定符和类型	类	说明
static class	MaterialDesc.MaterialAlphaMode	Describes available alpha rendering modes of materials.
static class	MaterialDesc.MaterialType	Enumerates material types.

字段概要

字段

限定符和类型	字段	说明
static int	MATERIAL_CLEAR_COAT_BIT	Specifies whether to use clear-coat parameters to simulate the multilayer material that has a thin translucent layer over a standard layer.
static int	MATERIAL_DOUBLE_SIDED_BIT	Specifies whether this material is double-sided (disabled by default).
static int	MATERIAL_NORMAL_MAP_BIT	Specifies whether this material has a normal map enabled.
static int	MATERIAL_SHADOW_RECEIVER_BIT	Specifies whether this material receives shadows.

构造器概要

构造器

构造器	说明
MaterialDesc()

方法概要

限定符和类型	方法	说明
float	getAlphaCutoff()	Obtains the alpha cutoff value of this material.
MaterialDesc.MaterialAlphaMode	getAlphaMode()	Obtains the alpha rendering mode of this material.
GpuResourceHandle	getAmbientOcclusion()	Obtains the handle to the ambient occlusion texture.
float	getAmbientOcclusionFactor()	Obtains the ambient occlusion factor of this material.
GpuResourceHandle	getBaseColor()	Obtains the handle to the base color texture.
Vector4	getBaseColorFactor()	Obtains the base color factor of this material.
float	getClearCoatFactor()	Obtains the clear coat factor of this material, which is used if MATERIAL_CLEAR_COAT_BIT is set by calling setMaterialFlags(int).
float	getClearCoatRoughness()	Obtains the clear coat roughness of this material, which is used if MATERIAL_CLEAR_COAT_BIT is set by calling setMaterialFlags(int).
GpuResourceHandle	getEmissive()	Obtains the handle to the emissive texture.
Vector3	getEmissiveFactor()	Obtains the emissive factor of this material.
float	getGlossinessFactor()	Obtains the glossiness factor of this material, which is used if the material type is set to MaterialType#SPECULAR_GLOSSINESS.
GpuResourceHandle	getMaterial()	Obtains the handle to the material texture.
int	getMaterialFlags()	Obtains the material flags that define the shader variant to be used by this material.
float	getMetallicFactor()	Obtains the metallic factor of this material, which is used if the material type is set to MaterialType#METALLIC_ROUGHNESS.
GpuResourceHandle	getNormal()	Obtains the handle to the normal texture.
float	getNormalScale()	Obtains the normal scale.
float	getReflectance()	Obtains the reflectance of this material.
float	getRoughnessFactor()	Obtains the roughness factor of this material, which is used if the material type is set to MaterialType#METALLIC_ROUGHNESS.
GpuResourceHandle	getSampler()	Obtains the handle to the sampler used by this material.
Vector3	getSpecularFactor()	Obtains the specular factor (specular RGB color) of this material, which is used if the material type is set to MaterialType#SPECULAR_GLOSSINESS.
MaterialDesc.MaterialType	getType()	Obtains the type of this material.
void	setAlphaCutoff(float alphaCutoff)	Sets the alpha cutoff value of this material, which is used if the alpha mode is set to MaterialAlphaMode#MASK.
void	setAlphaMode(MaterialDesc.MaterialAlphaMode alphaMode)	Sets the alpha rendering mode of this material.
void	setAmbientOcclusion(GpuResourceHandle ambientOcclusion)	Sets a handle for the ambient occlusion texture.
void	setAmbientOcclusionFactor(float ambientOcclusionFactor)	Sets the ambient occlusion factor of this material.
void	setBaseColor(GpuResourceHandle baseColor)	Sets a handle for the base color texture of this material.
void	setBaseColorFactor(Vector4 baseColorFactor)	Sets the base color factor of this material.
void	setClearCoatFactor(float clearCoatFactor)	Sets the clear coat factor of this materiel.
void	setClearCoatRoughness(float clearCoatRoughness)	Sets the clear coat roughness of this material, which is used if MATERIAL_CLEAR_COAT_BIT is set by calling setMaterialFlags(int).
void	setEmissive(GpuResourceHandle emissive)	Sets a handle for the emissive texture of this material.
void	setEmissiveFactor(Vector3 emissiveFactor)	Sets the emissive factor of this material.
void	setGlossinessFactor(float glossinessFactor)	Sets the glossiness factor of this material.
void	setMaterial(GpuResourceHandle material)	Sets a handle for the material texture.
void	setMaterialFlags(int materialFlags)	Sets the material flags that define the shader variant to be used by this material.
void	setMetallicFactor(float metallicFactor)	Sets the metallic factor of this material.
void	setNormal(GpuResourceHandle normal)	Sets a handle for the normal texture of this material.
void	setNormalScale(float normalScale)	Sets the normal scale of this material.
void	setReflectance(float reflectance)	Sets the reflectance of this material at normal incidence.
void	setRoughnessFactor(float roughnessFactor)	Sets the roughness factor of this material.
void	setSampler(GpuResourceHandle sampler)	Sets a handle for the sampler used by this material.
void	setSpecularFactor(Vector3 specularFactor)	Sets the specular factor (specular RGB color) of this material.
void	setType(MaterialDesc.MaterialType type)	Sets the type of this material.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

MATERIAL_CLEAR_COAT_BIT

public static final int MATERIAL_CLEAR_COAT_BIT

Specifies whether to use clear-coat parameters to simulate the multilayer material that has a thin translucent layer over a standard layer. It is used by setMaterialFlags(int).

另请参阅:

常量字段值

MATERIAL_DOUBLE_SIDED_BIT

public static final int MATERIAL_DOUBLE_SIDED_BIT

Specifies whether this material is double-sided (disabled by default). It is used by setMaterialFlags(int).

另请参阅:

常量字段值

MATERIAL_NORMAL_MAP_BIT

public static final int MATERIAL_NORMAL_MAP_BIT

Specifies whether this material has a normal map enabled. It is used by setMaterialFlags(int).

另请参阅:

常量字段值

MATERIAL_SHADOW_RECEIVER_BIT

public static final int MATERIAL_SHADOW_RECEIVER_BIT

Specifies whether this material receives shadows. It is used by setMaterialFlags(int).

另请参阅:

常量字段值

构造器详细资料

MaterialDesc

public MaterialDesc()

方法详细资料

getType

public MaterialDesc.MaterialType getType()

Obtains the type of this material.

返回:

Returns the type of this material.

setType

public void setType(MaterialDesc.MaterialType type)

Sets the type of this material.

参数:

type - Indicates the material type.

getBaseColor

public GpuResourceHandle getBaseColor()

Obtains the handle to the base color texture.

返回:

Returns the set handle to the base color texture if any; returns null otherwise.

setBaseColor

public void setBaseColor(GpuResourceHandle baseColor)

Sets a handle for the base color texture of this material.

参数:

baseColor - Indicates the GpuResourceHandle object defining the handle to the base color texture.

getNormal

public GpuResourceHandle getNormal()

Obtains the handle to the normal texture.

返回:

Returns the set handle to the normal texture if any; returns null otherwise.

setNormal

public void setNormal(GpuResourceHandle normal)

Sets a handle for the normal texture of this material.

参数:

normal - Indicates the GpuResourceHandle object defining the handle to the normal texture.

getEmissive

public GpuResourceHandle getEmissive()

Obtains the handle to the emissive texture.

返回:

Returns the set handle to the emissive texture if any; returns null otherwise.

setEmissive

public void setEmissive(GpuResourceHandle emissive)

Sets a handle for the emissive texture of this material.

参数:

emissive - Indicates the GpuResourceHandle object defining the handle to the emissive texture.

getMaterial

public GpuResourceHandle getMaterial()

Obtains the handle to the material texture. The material texture defines the metallic roughness or specular glossiness depending on the material type set by calling setType(ohos.agp.render.render3d.resources.MaterialDesc.MaterialType).

返回:

Returns the set handle to the material texture if any; returns null otherwise.

setMaterial

public void setMaterial(GpuResourceHandle material)

Sets a handle for the material texture. For details, see getMaterial().

参数:

material - Indicates the GpuResourceHandle object defining the handle to the material texture.

getAmbientOcclusion

public GpuResourceHandle getAmbientOcclusion()

Obtains the handle to the ambient occlusion texture.

返回:

Returns the set handle to the ambient occlusion texture if any; returns null otherwise.

setAmbientOcclusion

public void setAmbientOcclusion(GpuResourceHandle ambientOcclusion)

Sets a handle for the ambient occlusion texture.

参数:

ambientOcclusion - Indicates the GpuResourceHandle object defining the handle to the ambient occlusion texture.

getSampler

public GpuResourceHandle getSampler()

Obtains the handle to the sampler used by this material.

返回:

Returns the handle to the sampler used by this material.

setSampler

public void setSampler(GpuResourceHandle sampler)

Sets a handle for the sampler used by this material.

参数:

sampler - Indicates the GpuResourceHandle object defining the handle to the sampler.

getBaseColorFactor

public Vector4 getBaseColorFactor()

Obtains the base color factor of this material. If a base color texture is set by calling setBaseColor(ohos.agp.render.render3d.resources.GpuResourceHandle), the texture values will be multiplied by this factor.

返回:

Returns the base color factor of this material.

setBaseColorFactor

public void setBaseColorFactor(Vector4 baseColorFactor)

Sets the base color factor of this material. For details, see getBaseColorFactor().

参数:

baseColorFactor - Indicates the Vector4 object containing the base color factor.

getEmissiveFactor

public Vector3 getEmissiveFactor()

Obtains the emissive factor of this material. If an emissive texture is set by calling setEmissive(ohos.agp.render.render3d.resources.GpuResourceHandle), the texture values will be multiplied by this factor. The factor value ranges from 0.0 (not emissive) to 1.0 (fully emissive).

返回:

Returns the emissive factor of this material.

setEmissiveFactor

public void setEmissiveFactor(Vector3 emissiveFactor)

Sets the emissive factor of this material. For details, see getEmissiveFactor().

参数:

emissiveFactor - Indicates the Vector3 object containing the emissive factor.

getAmbientOcclusionFactor

public float getAmbientOcclusionFactor()

Obtains the ambient occlusion factor of this material. If an ambient occlusion texture is set by calling setAmbientOcclusion(ohos.agp.render.render3d.resources.GpuResourceHandle), the texture value will be multiplied by this factor. The factor value ranges from 0.0 (no ambient occlusion) to 1.0 (all ambient occlusion).

返回:

Returns the ambient occlusion factor of this material.

setAmbientOcclusionFactor

public void setAmbientOcclusionFactor(float ambientOcclusionFactor)

Sets the ambient occlusion factor of this material. For details, see getAmbientOcclusionFactor().

参数:

ambientOcclusionFactor - Indicates the ambient occlusion factor to set.

getRoughnessFactor

public float getRoughnessFactor()

Obtains the roughness factor of this material, which is used if the material type is set to MaterialType#METALLIC_ROUGHNESS. The factor value ranges from 0.0 (smooth) to 1.0 (rough).

返回:

Returns the roughness factor of this material.

setRoughnessFactor

public void setRoughnessFactor(float roughnessFactor)

Sets the roughness factor of this material. For details, see getRoughnessFactor().

参数:

roughnessFactor - Indicates the roughness factor to set.

getMetallicFactor

public float getMetallicFactor()

Obtains the metallic factor of this material, which is used if the material type is set to MaterialType#METALLIC_ROUGHNESS. The factor value ranges from 0.0 (dielectric) to 1.0 (metallic).

返回:

Returns the metallic factor of this material.

setMetallicFactor

public void setMetallicFactor(float metallicFactor)

Sets the metallic factor of this material. For details, see getMetallicFactor().

参数:

metallicFactor - Indicates the metallic factor.

getReflectance

public float getReflectance()

Obtains the reflectance of this material.

返回:

Returns the reflectance of this material.

setReflectance

public void setReflectance(float reflectance)

Sets the reflectance of this material at normal incidence. The default value is 0.04.

参数:

reflectance - Indicates the reflectance to set.

getNormalScale

public float getNormalScale()

Obtains the normal scale. This is a scalar multiplier applied to each normal vector of the texture. The scale will be ignored if no normal texture is specified. This value is linear.

返回:

Returns the normal scale of this material.

setNormalScale

public void setNormalScale(float normalScale)

Sets the normal scale of this material. For details, see getNormalScale().

参数:

normalScale - Indicates the normal scale to set.

getSpecularFactor

public Vector3 getSpecularFactor()

Obtains the specular factor (specular RGB color) of this material, which is used if the material type is set to MaterialType#SPECULAR_GLOSSINESS. This value is linear, and the default value is 1.0, 1.0, 1.0.

返回:

Returns the specular factor of this material.

setSpecularFactor

public void setSpecularFactor(Vector3 specularFactor)

Sets the specular factor (specular RGB color) of this material. For details, see getSpecularFactor().

参数:

specularFactor - Indicates the Vector3 object containing the specular factor.

getGlossinessFactor

public float getGlossinessFactor()

Obtains the glossiness factor of this material, which is used if the material type is set to MaterialType#SPECULAR_GLOSSINESS. The glossiness factor defines how glossy (or smooth) a material is. The factor value ranges from 0.0 (completely rough or not glossy) to 1.0 (perfectly smooth or fully glossy).

返回:

Returns the glossiness factor of this material.

setGlossinessFactor

public void setGlossinessFactor(float glossinessFactor)

Sets the glossiness factor of this material. For details, see getGlossinessFactor().

参数:

glossinessFactor - Indicates the glossiness factor to set.

getClearCoatFactor

public float getClearCoatFactor()

Obtains the clear coat factor of this material, which is used if MATERIAL_CLEAR_COAT_BIT is set by calling setMaterialFlags(int). The default value is 0.0.

返回:

Returns the clear coat factor of this material.

setClearCoatFactor

public void setClearCoatFactor(float clearCoatFactor)

Sets the clear coat factor of this materiel. The default value is 0.5. For details, see getClearCoatFactor().

参数:

clearCoatFactor - Indicates the clear coat factor to set.

getClearCoatRoughness

public float getClearCoatRoughness()

Obtains the clear coat roughness of this material, which is used if MATERIAL_CLEAR_COAT_BIT is set by calling setMaterialFlags(int). The default value is 0.5.

返回:

Returns the clear coat roughness of this material.

setClearCoatRoughness

public void setClearCoatRoughness(float clearCoatRoughness)

Sets the clear coat roughness of this material, which is used if MATERIAL_CLEAR_COAT_BIT is set by calling setMaterialFlags(int). The default value is 0.5.

参数:

clearCoatRoughness - Indicates the clear coat roughness to set.

getAlphaMode

public MaterialDesc.MaterialAlphaMode getAlphaMode()

Obtains the alpha rendering mode of this material.

返回:

Returns the alpha rendering mode of this material.

setAlphaMode

public void setAlphaMode(MaterialDesc.MaterialAlphaMode alphaMode)

Sets the alpha rendering mode of this material. For available alpha modes, see MaterialDesc.MaterialAlphaMode.

参数:

alphaMode - Indicates the alpha rendering mode to set.

getAlphaCutoff

public float getAlphaCutoff()

Obtains the alpha cutoff value of this material.

返回:

Returns the alpha cutoff value of this material.

setAlphaCutoff

public void setAlphaCutoff(float alphaCutoff)

Sets the alpha cutoff value of this material, which is used if the alpha mode is set to MaterialAlphaMode#MASK. The value ranges from 0.0 to 1.0.

参数:

alphaCutoff - Indicates the alpha cutoff value to set.

getMaterialFlags

public int getMaterialFlags()

Obtains the material flags that define the shader variant to be used by this material. The flags can be a combination of MATERIAL_DOUBLE_SIDED_BIT, MATERIAL_CLEAR_COAT_BIT, MATERIAL_SHADOW_RECEIVER_BIT, and MATERIAL_NORMAL_MAP_BIT.

返回:

Returns the flags of this material.

setMaterialFlags

public void setMaterialFlags(int materialFlags)

Sets the material flags that define the shader variant to be used by this material. For details, see getMaterialFlags().

参数:

materialFlags - Indicates the material flags to set.