asset_preparation::v3::hdri_sky::HdriSkyPreparation Class Reference
Last update: 16.07.2025HDRI Sky Preparation Service. More...
Detailed Description
HDRI Sky Preparation Service.
This service is used to create, edit and manage HDRI skies.
Member Function Documentation
◆ CreateHdriSky()
| CreateHdriSkyResponse asset_preparation::v3::hdri_sky::HdriSkyPreparation::CreateHdriSky | ( | CreateHdriSkyRequest | ) |
Creates a new HDRI sky with an optional name.
- Note
- Names must be unique amongst skies.
- If unspecified, default values are used.
Returns the identifier of the created HDRI sky.
◆ GetHdriSky()
| GetHdriSkyResponse asset_preparation::v3::hdri_sky::HdriSkyPreparation::GetHdriSky | ( | GetHdriSkyRequest | ) |
Gets the properties of an HDRI sky, given its identifier.
Returns the HDRI sky properties.
◆ ListHdriSkies()
| ListHdriSkiesResponse asset_preparation::v3::hdri_sky::HdriSkyPreparation::ListHdriSkies | ( | google::protobuf::Empty | ) |
Lists all the created HDRI skies.
Returns the identifiers and names of the HDRI skies.
◆ UpdateHdriSky()
| UpdateHdriSkyResponse asset_preparation::v3::hdri_sky::HdriSkyPreparation::UpdateHdriSky | ( | UpdateHdriSkyRequest | ) |
Edits the properties of an HDRI sky, given its identifier.
- Note
- Names must be unique amongst skies.
◆ DeleteHdriSky()
| DeleteHdriSkyResponse asset_preparation::v3::hdri_sky::HdriSkyPreparation::DeleteHdriSky | ( | DeleteHdriSkyRequest | ) |
Deletes an HDRI sky, given its identifier.
- Note
- If you delete an HDRI sky that is set as the active_sky in an environment, the environment is updated with the default sky set as the active sky.
◆ CreateHdriSkyState()
| CreateHdriSkyStateResponse asset_preparation::v3::hdri_sky::HdriSkyPreparation::CreateHdriSkyState | ( | CreateHdriSkyStateRequest | ) |
Creates a new HDRI sky state with optional properties.
- Note
- Names must be unique amongst sibling states.
- "Default" name is reserved.
- If some properties are not specified, default values are used.
Returns the information about the created HDRI sky state.
◆ GetHdriSkyState()
| GetHdriSkyStateResponse asset_preparation::v3::hdri_sky::HdriSkyPreparation::GetHdriSkyState | ( | GetHdriSkyStateRequest | ) |
Gets the properties of an HDRI sky state, given the parent HDRI sky identifier and the state name.
Returns the HDRI sky state properties.
◆ UpdateHdriSkyState()
| UpdateHdriSkyStateResponse asset_preparation::v3::hdri_sky::HdriSkyPreparation::UpdateHdriSkyState | ( | UpdateHdriSkyStateRequest | ) |
Edits the properties of a state, given the parent HDRI sky identifier and the state name.
- Note
- Names must be unique amongst sibling states.
- "Default" name is reserved.
◆ DeleteHdriSkyState()
| DeleteHdriSkyStateResponse asset_preparation::v3::hdri_sky::HdriSkyPreparation::DeleteHdriSkyState | ( | DeleteHdriSkyStateRequest | ) |
Deletes an HDRI sky state, given the parent HDRI sky identifier and the state name.
The documentation for this class was generated from the following file:
- hdri_sky.proto
