vrdRoughnessTexture¶
-
class
vrdRoughnessTexture¶
(Inherits vrdTexture)
This class is used for all roughness texture properties.
To load an image for a roughness texture, use:
image = vrImageService.loadImage(filename, vrImageTypes.LoadType.RawData)
material.getRoughnessTexture().setImage(image)
material.getRoughnessTexture().setUseTexture(True)
Summary¶
- Functions:
- getMaximumRoughness() → float
- getMaximumRoughnessU() → float
- getMaximumRoughnessV() → float
- getMinimumRoughness() → float
- getMinimumRoughnessU() → float
- getMinimumRoughnessV() → float
- getRoughnessMapType() → vrRoughnessTextureTypes.ValueMapping
- setMaximumRoughness(maximumRoughness)
- setMaximumRoughnessU(maximumRoughness)
- setMaximumRoughnessV(maximumRoughness)
- setMinimumRoughness(minimumRoughness)
- setMinimumRoughnessU(minimumRoughness)
- setMinimumRoughnessV(minimumRoughness)
- setRoughnessMapType(mapping)
Functions¶
-
vrdRoughnessTexture.getMaximumRoughness()¶ Gets the roughness value in U direction to which a texture value of 1 is mapped. Note: this function does the same as calling vrdRoughnessTexture.getMaximumRoughnessU()
Returns: Current value for the roughness value to which a texture value of 1 is mapped. Return type: float
-
vrdRoughnessTexture.getMaximumRoughnessU()¶ Gets the roughness value in U direction to which a texture value of 1 is mapped.
Returns: Current value for the roughness value to which a texture value of 1 is mapped. Return type: float
-
vrdRoughnessTexture.getMaximumRoughnessV()¶ Gets the roughness value in V direction to which a texture value of 1 is mapped.
Returns: Current value for the roughness value to which a texture value of 1 is mapped. Return type: float
-
vrdRoughnessTexture.getMinimumRoughness()¶ Gets the roughness value in U direction to which a texture value of 0 is mapped. Note: this function does the same as calling vrdRoughnessTexture.getMinimumRoughnessU()
Returns: Current value for the roughness value to which a texture value of 0 is mapped. Return type: float
-
vrdRoughnessTexture.getMinimumRoughnessU()¶ Gets the roughness value in U direction to which a texture value of 0 is mapped.
Returns: Current value for the roughness value to which a texture value of 0 is mapped. Return type: float
-
vrdRoughnessTexture.getMinimumRoughnessV()¶ Gets the roughness value in V direction to which a texture value of 0 is mapped.
Returns: Current value for the roughness value to which a texture value of 0 is mapped. Return type: float
-
vrdRoughnessTexture.getRoughnessMapType()¶ Returns the current roughness texture value map type.
Returns: Current roughness texture value map type Return type: vrRoughnessTextureTypes.ValueMapping
-
vrdRoughnessTexture.setMaximumRoughness(maximumRoughness)¶ Sets the roughness value in U direction to which a texture value of 1 is mapped. Note: this function does the same as calling vrdRoughnessTexture.setMaximumRoughnessU(maximumRoughness)
Parameters: maximumRoughness (float) – New value for the roughness value to which a texture value of 1 is mapped.
-
vrdRoughnessTexture.setMaximumRoughnessU(maximumRoughness)¶ Sets the roughness value in U direction to which a texture value of 1 is mapped.
Parameters: maximumRoughness (float) – New value for the roughness value to which a texture value of 1 is mapped.
-
vrdRoughnessTexture.setMaximumRoughnessV(maximumRoughness)¶ Sets the roughness value in V direction to which a texture value of 1 is mapped.
Parameters: maximumRoughness (float) – New value for the roughness value to which a texture value of 1 is mapped.
-
vrdRoughnessTexture.setMinimumRoughness(minimumRoughness)¶ Sets the roughness value in U direction to which a texture value of 0 is mapped. Note: this function does the same as calling vrdRoughnessTexture.setMinimumRoughnessU(minimumRoughness)
Parameters: minimumRoughness (float) – New value for the roughness value to which a texture value of 0 is mapped.
-
vrdRoughnessTexture.setMinimumRoughnessU(minimumRoughness)¶ Sets the roughness value in U direction to which a texture value of 0 is mapped.
Parameters: minimumRoughness (float) – New value for the roughness value to which a texture value of 0 is mapped.
-
vrdRoughnessTexture.setMinimumRoughnessV(minimumRoughness)¶ Sets the roughness value in V direction to which a texture value of 0 is mapped.
Parameters: minimumRoughness (float) – New value for the roughness value to which a texture value of 0 is mapped.
-
vrdRoughnessTexture.setRoughnessMapType(mapping)¶ Sets the mapping of the texture values to roughness values.
Parameters: mapping (vrRoughnessTextureTypes.ValueMapping) – Roughness map type to set. Available modes are Linear and Legacy