    

 ## On this page

  

 

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

 Last update: 16.07.2025 

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

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

[CreateDirectionalLightResponse](a00143.xhtml) [CreateDirectionalLight](a00135.xhtml#aab8322dd90f821e131a05966333a1cf8) ([CreateDirectionalLightRequest](a00139.xhtml)) [GetDirectionalLightResponse](a00151.xhtml) [GetDirectionalLight](a00135.xhtml#a38ac22635a3daf8c87773ebe74564b21) ([GetDirectionalLightRequest](a00147.xhtml)) [ListDirectionalLightsResponse](a00155.xhtml) [ListDirectionalLights](a00135.xhtml#af572c8ee54a2ca0df0ac75abd1517007) (google::protobuf::Empty) [UpdateDirectionalLightResponse](a00163.xhtml) [UpdateDirectionalLight](a00135.xhtml#a293b5f6c4cdaa4011063cc0ea27e0f8d) ([UpdateDirectionalLightRequest](a00159.xhtml)) [DeleteDirectionalLightResponse](a00171.xhtml) [DeleteDirectionalLight](a00135.xhtml#a1de42836c4ac6b4b70cca92a46e10de4) ([DeleteDirectionalLightRequest](a00167.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="aab8322dd90f821e131a05966333a1cf8"></a>## [◆ ](#aab8322dd90f821e131a05966333a1cf8)CreateDirectionalLight()

 [CreateDirectionalLightResponse](a00143.xhtml) asset\_preparation::v1::directional\_light::DirectionalLightPreparation::CreateDirectionalLight  ( [CreateDirectionalLightRequest](a00139.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="a1de42836c4ac6b4b70cca92a46e10de4"></a>## [◆ ](#a1de42836c4ac6b4b70cca92a46e10de4)DeleteDirectionalLight()

 [DeleteDirectionalLightResponse](a00171.xhtml) asset\_preparation::v1::directional\_light::DirectionalLightPreparation::DeleteDirectionalLight  ( [DeleteDirectionalLightRequest](a00167.xhtml)  ) 

Deletes a directional light, given its identifier.





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

 [GetDirectionalLightResponse](a00151.xhtml) asset\_preparation::v1::directional\_light::DirectionalLightPreparation::GetDirectionalLight  ( [GetDirectionalLightRequest](a00147.xhtml)  ) 

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

Returns the directional light properties.





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

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

Lists all the created directional lights.

Returns the identifiers and names of the directional lights.





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

 [UpdateDirectionalLightResponse](a00163.xhtml) asset\_preparation::v1::directional\_light::DirectionalLightPreparation::UpdateDirectionalLight  ( [UpdateDirectionalLightRequest](a00159.xhtml)  ) 

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

NoteNames must be unique amongst directional lights. 



---

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