## On this page

  

 

 # asset\_preparation::v3::hdri\_sky::HdriSkyPreparation Class Reference

 Last update: 16.07.2025 

HDRI Sky Preparation Service. [More...](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

[CreateHdriSkyResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_create_hdri_sky_response.xhtml) [CreateHdriSky](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#a64fb0c99c0da24c29e027d590eb33d7e) ([CreateHdriSkyRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_create_hdri_sky_request.xhtml)) [GetHdriSkyResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_get_hdri_sky_response.xhtml) [GetHdriSky](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#aed7fd70bc757cd3829ac1300c4a25913) ([GetHdriSkyRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_get_hdri_sky_request.xhtml)) [ListHdriSkiesResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_list_hdri_skies_response.xhtml) [ListHdriSkies](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#af5f6f317412f645ea3b3981770c7936b) (google::protobuf::Empty) [UpdateHdriSkyResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_update_hdri_sky_response.xhtml) [UpdateHdriSky](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#a405668d8794157f37d7d19603565fcd0) ([UpdateHdriSkyRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_update_hdri_sky_request.xhtml)) [DeleteHdriSkyResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_delete_hdri_sky_response.xhtml) [DeleteHdriSky](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#aed3fa04dcc52f9e6f245b727b087b651) ([DeleteHdriSkyRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_delete_hdri_sky_request.xhtml)) [CreateHdriSkyStateResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_create_hdri_sky_state_response.xhtml) [CreateHdriSkyState](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#a640a0ef1377e7bf7456ea9faecba6fe7) ([CreateHdriSkyStateRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_create_hdri_sky_state_request.xhtml)) [GetHdriSkyStateResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_get_hdri_sky_state_response.xhtml) [GetHdriSkyState](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#a762e6fbb72d1ffe4544944d7ecff6059) ([GetHdriSkyStateRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_get_hdri_sky_state_request.xhtml)) [UpdateHdriSkyStateResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_update_hdri_sky_state_response.xhtml) [UpdateHdriSkyState](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#a3235698e7f412426d497ac0b489ce6f6) ([UpdateHdriSkyStateRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_update_hdri_sky_state_request.xhtml)) [DeleteHdriSkyStateResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_delete_hdri_sky_state_response.xhtml) [DeleteHdriSkyState](classasset__preparation_1_1v3_1_1hdri__sky_1_1_hdri_sky_preparation.xhtml#a3ce5fc33eda74e8fae160a35b180bc1f) ([DeleteHdriSkyStateRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_delete_hdri_sky_state_request.xhtml)) <a id="details" name="details"></a>## Detailed Description

HDRI Sky Preparation Service.

This service is used to create, edit and manage HDRI skies.



## Member Function Documentation

<a id="a64fb0c99c0da24c29e027d590eb33d7e"></a>## [◆ ](#a64fb0c99c0da24c29e027d590eb33d7e)CreateHdriSky()

 [CreateHdriSkyResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_create_hdri_sky_response.xhtml) asset\_preparation::v3::hdri\_sky::HdriSkyPreparation::CreateHdriSky  ( [CreateHdriSkyRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_create_hdri_sky_request.xhtml)  ) 

Creates a new HDRI sky with an optional name.

NoteNames must be unique amongst skies.If unspecified, default values are used.Returns the identifier of the created HDRI sky.





<a id="aed7fd70bc757cd3829ac1300c4a25913"></a>## [◆ ](#aed7fd70bc757cd3829ac1300c4a25913)GetHdriSky()

 [GetHdriSkyResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_get_hdri_sky_response.xhtml) asset\_preparation::v3::hdri\_sky::HdriSkyPreparation::GetHdriSky  ( [GetHdriSkyRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_get_hdri_sky_request.xhtml)  ) 

Gets the properties of an HDRI sky, given its identifier.

Returns the HDRI sky properties.





<a id="af5f6f317412f645ea3b3981770c7936b"></a>## [◆ ](#af5f6f317412f645ea3b3981770c7936b)ListHdriSkies()

 [ListHdriSkiesResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_list_hdri_skies_response.xhtml) 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.





<a id="a405668d8794157f37d7d19603565fcd0"></a>## [◆ ](#a405668d8794157f37d7d19603565fcd0)UpdateHdriSky()

 [UpdateHdriSkyResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_update_hdri_sky_response.xhtml) asset\_preparation::v3::hdri\_sky::HdriSkyPreparation::UpdateHdriSky  ( [UpdateHdriSkyRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_update_hdri_sky_request.xhtml)  ) 

Edits the properties of an HDRI sky, given its identifier.

NoteNames must be unique amongst skies. 



<a id="aed3fa04dcc52f9e6f245b727b087b651"></a>## [◆ ](#aed3fa04dcc52f9e6f245b727b087b651)DeleteHdriSky()

 [DeleteHdriSkyResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_delete_hdri_sky_response.xhtml) asset\_preparation::v3::hdri\_sky::HdriSkyPreparation::DeleteHdriSky  ( [DeleteHdriSkyRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_delete_hdri_sky_request.xhtml)  ) 

Deletes an HDRI sky, given its identifier.

NoteIf 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. 



<a id="a640a0ef1377e7bf7456ea9faecba6fe7"></a>## [◆ ](#a640a0ef1377e7bf7456ea9faecba6fe7)CreateHdriSkyState()

 [CreateHdriSkyStateResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_create_hdri_sky_state_response.xhtml) asset\_preparation::v3::hdri\_sky::HdriSkyPreparation::CreateHdriSkyState  ( [CreateHdriSkyStateRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_create_hdri_sky_state_request.xhtml)  ) 

Creates a new HDRI sky state with optional properties.

NoteNames 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.





<a id="a762e6fbb72d1ffe4544944d7ecff6059"></a>## [◆ ](#a762e6fbb72d1ffe4544944d7ecff6059)GetHdriSkyState()

 [GetHdriSkyStateResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_get_hdri_sky_state_response.xhtml) asset\_preparation::v3::hdri\_sky::HdriSkyPreparation::GetHdriSkyState  ( [GetHdriSkyStateRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_get_hdri_sky_state_request.xhtml)  ) 

Gets the properties of an HDRI sky state, given the parent HDRI sky identifier and the state name.

Returns the HDRI sky state properties.





<a id="a3235698e7f412426d497ac0b489ce6f6"></a>## [◆ ](#a3235698e7f412426d497ac0b489ce6f6)UpdateHdriSkyState()

 [UpdateHdriSkyStateResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_update_hdri_sky_state_response.xhtml) asset\_preparation::v3::hdri\_sky::HdriSkyPreparation::UpdateHdriSkyState  ( [UpdateHdriSkyStateRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_update_hdri_sky_state_request.xhtml)  ) 

Edits the properties of a state, given the parent HDRI sky identifier and the state name.

NoteNames must be unique amongst sibling states."Default" name is reserved. 



<a id="a3ce5fc33eda74e8fae160a35b180bc1f"></a>## [◆ ](#a3ce5fc33eda74e8fae160a35b180bc1f)DeleteHdriSkyState()

 [DeleteHdriSkyStateResponse](structasset__preparation_1_1v3_1_1hdri__sky_1_1_delete_hdri_sky_state_response.xhtml) asset\_preparation::v3::hdri\_sky::HdriSkyPreparation::DeleteHdriSkyState  ( [DeleteHdriSkyStateRequest](structasset__preparation_1_1v3_1_1hdri__sky_1_1_delete_hdri_sky_state_request.xhtml)  ) 

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