## On this page

  

 

 # asset\_preparation::v3::directional\_light::DirectionalLightPreparation Class Reference

 Last update: 16.07.2025 

Directional Light Preparation Service. [More...](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#details)

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

[CreateDirectionalLightResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_create_directional_light_response.xhtml) [CreateDirectionalLight](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#afcb1cecc5e212b0896cf35f5431850b6) ([CreateDirectionalLightRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_create_directional_light_request.xhtml)) [GetDirectionalLightResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_get_directional_light_response.xhtml) [GetDirectionalLight](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#a29c40c0a04067bcb7260f16070e2220d) ([GetDirectionalLightRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_get_directional_light_request.xhtml)) [ListDirectionalLightsResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_list_directional_lights_response.xhtml) [ListDirectionalLights](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#a2d9b10aa955e0ef19bf1d234120e002c) (google::protobuf::Empty) [UpdateDirectionalLightResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_update_directional_light_response.xhtml) [UpdateDirectionalLight](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#af42fc0ec013e89e8556970902d17ff07) ([UpdateDirectionalLightRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_update_directional_light_request.xhtml)) [DeleteDirectionalLightResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_delete_directional_light_response.xhtml) [DeleteDirectionalLight](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#af949dbd279a0ccdc604d3561112ff409) ([DeleteDirectionalLightRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_delete_directional_light_request.xhtml)) [CreateDirectionalLightStateResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_create_directional_light_state_response.xhtml) [CreateDirectionalLightState](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#af4eafd28c6b45b8d234c6fb4a907a506) ([CreateDirectionalLightStateRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_create_directional_light_state_request.xhtml)) [GetDirectionalLightStateResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_get_directional_light_state_response.xhtml) [GetDirectionalLightState](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#a8730bdea178fcc5161769945851b548a) ([GetDirectionalLightStateRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_get_directional_light_state_request.xhtml)) [UpdateDirectionalLightStateResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_update_directional_light_state_response.xhtml) [UpdateDirectionalLightState](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#a3f037772af2436591d5fa9d5f8585723) ([UpdateDirectionalLightStateRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_update_directional_light_state_request.xhtml)) [DeleteDirectionalLightStateResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_delete_directional_light_state_response.xhtml) [DeleteDirectionalLightState](classasset__preparation_1_1v3_1_1directional__light_1_1_directional_light_preparation.xhtml#a911388cf8808c8bb655f7751e5ec83d6) ([DeleteDirectionalLightStateRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_delete_directional_light_state_request.xhtml)) <a id="details" name="details"></a>## Detailed Description

Directional Light Preparation Service.

This service is used to create, edit and manage directional lights.



## Member Function Documentation

<a id="afcb1cecc5e212b0896cf35f5431850b6"></a>## [◆ ](#afcb1cecc5e212b0896cf35f5431850b6)CreateDirectionalLight()

 [CreateDirectionalLightResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_create_directional_light_response.xhtml) asset\_preparation::v3::directional\_light::DirectionalLightPreparation::CreateDirectionalLight  ( [CreateDirectionalLightRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_create_directional_light_request.xhtml)  ) 

Creates a new directional light with an optional name, type and shadows.

NoteNames must be unique amongst sibling directional lights.If unspecified, default values are used.Returns the identifier of the created directional light.





<a id="a29c40c0a04067bcb7260f16070e2220d"></a>## [◆ ](#a29c40c0a04067bcb7260f16070e2220d)GetDirectionalLight()

 [GetDirectionalLightResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_get_directional_light_response.xhtml) asset\_preparation::v3::directional\_light::DirectionalLightPreparation::GetDirectionalLight  ( [GetDirectionalLightRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_get_directional_light_request.xhtml)  ) 

Gets the properties of a directional light, given its identifier.

Returns the directional light properties.





<a id="a2d9b10aa955e0ef19bf1d234120e002c"></a>## [◆ ](#a2d9b10aa955e0ef19bf1d234120e002c)ListDirectionalLights()

 [ListDirectionalLightsResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_list_directional_lights_response.xhtml) asset\_preparation::v3::directional\_light::DirectionalLightPreparation::ListDirectionalLights  ( google::protobuf::Empty  ) 

Lists all the created directional lights.

Returns the identifiers and names of the directional lights.





<a id="af42fc0ec013e89e8556970902d17ff07"></a>## [◆ ](#af42fc0ec013e89e8556970902d17ff07)UpdateDirectionalLight()

 [UpdateDirectionalLightResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_update_directional_light_response.xhtml) asset\_preparation::v3::directional\_light::DirectionalLightPreparation::UpdateDirectionalLight  ( [UpdateDirectionalLightRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_update_directional_light_request.xhtml)  ) 

Edits the properties of a directional light, given its identifier.

NoteNames must be unique amongst directional lights. 



<a id="af949dbd279a0ccdc604d3561112ff409"></a>## [◆ ](#af949dbd279a0ccdc604d3561112ff409)DeleteDirectionalLight()

 [DeleteDirectionalLightResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_delete_directional_light_response.xhtml) asset\_preparation::v3::directional\_light::DirectionalLightPreparation::DeleteDirectionalLight  ( [DeleteDirectionalLightRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_delete_directional_light_request.xhtml)  ) 

Deletes a directional light, given its identifier.





<a id="af4eafd28c6b45b8d234c6fb4a907a506"></a>## [◆ ](#af4eafd28c6b45b8d234c6fb4a907a506)CreateDirectionalLightState()

 [CreateDirectionalLightStateResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_create_directional_light_state_response.xhtml) asset\_preparation::v3::directional\_light::DirectionalLightPreparation::CreateDirectionalLightState  ( [CreateDirectionalLightStateRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_create_directional_light_state_request.xhtml)  ) 

Creates a new directional light state with optional properties.

NoteNames must be unique amongst sibling directional light states."Default" name is reserved.If some properties are not specified, default values are used.Returns the information about the created directional light state.





<a id="a8730bdea178fcc5161769945851b548a"></a>## [◆ ](#a8730bdea178fcc5161769945851b548a)GetDirectionalLightState()

 [GetDirectionalLightStateResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_get_directional_light_state_response.xhtml) asset\_preparation::v3::directional\_light::DirectionalLightPreparation::GetDirectionalLightState  ( [GetDirectionalLightStateRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_get_directional_light_state_request.xhtml)  ) 

Gets the properties of a directional light state, given the parent directional light identifier and the state name.

Returns the directional light state properties.





<a id="a3f037772af2436591d5fa9d5f8585723"></a>## [◆ ](#a3f037772af2436591d5fa9d5f8585723)UpdateDirectionalLightState()

 [UpdateDirectionalLightStateResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_update_directional_light_state_response.xhtml) asset\_preparation::v3::directional\_light::DirectionalLightPreparation::UpdateDirectionalLightState  ( [UpdateDirectionalLightStateRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_update_directional_light_state_request.xhtml)  ) 

Edits the properties of a state, given the parent directional light identifier and the state name.

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



<a id="a911388cf8808c8bb655f7751e5ec83d6"></a>## [◆ ](#a911388cf8808c8bb655f7751e5ec83d6)DeleteDirectionalLightState()

 [DeleteDirectionalLightStateResponse](structasset__preparation_1_1v3_1_1directional__light_1_1_delete_directional_light_state_response.xhtml) asset\_preparation::v3::directional\_light::DirectionalLightPreparation::DeleteDirectionalLightState  ( [DeleteDirectionalLightStateRequest](structasset__preparation_1_1v3_1_1directional__light_1_1_delete_directional_light_state_request.xhtml)  ) 

Deletes a directional light state, given the parent directional light identifier and the state name.





---

The documentation for this class was generated from the following file:- directional\_light.proto