asset_preparation::v2::surface_source::DisplaySourceProperties Struct Reference
Last update: 16.07.2025The properties of a display source. More...
Public Attributes | |
| google::protobuf::DoubleValue | luminance = 1 |
| google::protobuf::DoubleValue | angular_precision = 2 |
| LambertianDiagram | lambertian = 3 |
| LibraryDiagram | diagram_library = 4 |
| GaussianDiagram | gaussian = 5 |
| google::protobuf::BoolValue | reverse_direction = 6 |
| common::Empty | no_contribution = 7 |
| LightingContribution | lighting_contribution = 8 |
| SpectrumLibrary | spectrum_library = 9 |
| BlackBody | black_body = 10 |
| Monochromatic | monochromatic = 11 |
| google::protobuf::Int32Value | texture_id = 12 |
| google::protobuf::Int32Value | uv_channel = 13 |
Detailed Description
The properties of a display source.
- Note
- For display sources, the spectrum is only needed if the display source contributes to lighting.
Member Data Documentation
◆ angular_precision
| google::protobuf::DoubleValue asset_preparation::v2::surface_source::DisplaySourceProperties::angular_precision = 2 |
The angular precision.
Unit: Degree
- Note
- Must be positive.
- The default value is 0.
◆ black_body
| BlackBody asset_preparation::v2::surface_source::DisplaySourceProperties::black_body = 10 |
ONEOF(spectrum) Spectrum based on a black body.
◆ diagram_library
| LibraryDiagram asset_preparation::v2::surface_source::DisplaySourceProperties::diagram_library = 4 |
ONEOF(angular_diagram) Intensity based on a library angular diagram.
◆ gaussian
| GaussianDiagram asset_preparation::v2::surface_source::DisplaySourceProperties::gaussian = 5 |
ONEOF(angular_diagram) Intensity based on a gaussian angular diagram.
◆ lambertian
| LambertianDiagram asset_preparation::v2::surface_source::DisplaySourceProperties::lambertian = 3 |
ONEOF(angular_diagram) Intensity based on a Lambertian angular diagram.
- Note
- This is the default type of angular diagram.
◆ lighting_contribution
| LightingContribution asset_preparation::v2::surface_source::DisplaySourceProperties::lighting_contribution = 8 |
ONEOF(contribution) The lighting contribution of the display source.
◆ luminance
| google::protobuf::DoubleValue asset_preparation::v2::surface_source::DisplaySourceProperties::luminance = 1 |
The display source luminance.
Unit: candela/sq. meter (cd/m2)
- Note
- Must be positive.
- The default value is 0.
◆ monochromatic
| Monochromatic asset_preparation::v2::surface_source::DisplaySourceProperties::monochromatic = 11 |
ONEOF(spectrum) Monochromatic spectrum.
◆ no_contribution
| common::Empty asset_preparation::v2::surface_source::DisplaySourceProperties::no_contribution = 7 |
ONEOF(contribution) The display source does not contribute to lighting.
- Note
- This is the default value.
◆ reverse_direction
| google::protobuf::BoolValue asset_preparation::v2::surface_source::DisplaySourceProperties::reverse_direction = 6 |
Whether the direction of the display source is reversed.
◆ spectrum_library
| SpectrumLibrary asset_preparation::v2::surface_source::DisplaySourceProperties::spectrum_library = 9 |
ONEOF(spectrum) Spectrum based on a spectrum file.
- Note
- This is the default spectrum type.
◆ texture_id
| google::protobuf::Int32Value asset_preparation::v2::surface_source::DisplaySourceProperties::texture_id = 12 |
The identifier of the display texture (created using the Resource service) referenced in the display source.
- Note
- The texture reference can be removed by setting the value '-1'.
◆ uv_channel
| google::protobuf::Int32Value asset_preparation::v2::surface_source::DisplaySourceProperties::uv_channel = 13 |
The UV channel used to map the texture.
- Note
- Must be in the range [1,4].
- The default value is 1.
The documentation for this struct was generated from the following file:
- surface_source_description.proto
