    

 ## On this page

  

 

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

 Last update: 16.07.2025 

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

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

[CreateDirectionalLightResponse](a00275.xhtml) [CreateDirectionalLight](a00267.xhtml#aa296700e9853289e6234a0418384dfac) ([CreateDirectionalLightRequest](a00271.xhtml)) [GetDirectionalLightResponse](a00283.xhtml) [GetDirectionalLight](a00267.xhtml#a853be44d84481e223792c403fb4f91d7) ([GetDirectionalLightRequest](a00279.xhtml)) [ListDirectionalLightsResponse](a00287.xhtml) [ListDirectionalLights](a00267.xhtml#a0cb9df1fb536c5a61203064aca324819) (google::protobuf::Empty) [UpdateDirectionalLightResponse](a00295.xhtml) [UpdateDirectionalLight](a00267.xhtml#afad1e0ff341f0050f0d8416fca096ac9) ([UpdateDirectionalLightRequest](a00291.xhtml)) [DeleteDirectionalLightResponse](a00303.xhtml) [DeleteDirectionalLight](a00267.xhtml#a4ad9bdb3b482e9af510dbfd8838bedaf) ([DeleteDirectionalLightRequest](a00299.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="aa296700e9853289e6234a0418384dfac"></a>## [◆ ](#aa296700e9853289e6234a0418384dfac)CreateDirectionalLight()

 [CreateDirectionalLightResponse](a00275.xhtml) asset\_preparation::v2::directional\_light::DirectionalLightPreparation::CreateDirectionalLight  ( [CreateDirectionalLightRequest](a00271.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="a4ad9bdb3b482e9af510dbfd8838bedaf"></a>## [◆ ](#a4ad9bdb3b482e9af510dbfd8838bedaf)DeleteDirectionalLight()

 [DeleteDirectionalLightResponse](a00303.xhtml) asset\_preparation::v2::directional\_light::DirectionalLightPreparation::DeleteDirectionalLight  ( [DeleteDirectionalLightRequest](a00299.xhtml)  ) 

Deletes a directional light, given its identifier.





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

 [GetDirectionalLightResponse](a00283.xhtml) asset\_preparation::v2::directional\_light::DirectionalLightPreparation::GetDirectionalLight  ( [GetDirectionalLightRequest](a00279.xhtml)  ) 

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

Returns the directional light properties.





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

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

Lists all the created directional lights.

Returns the identifiers and names of the directional lights.





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

 [UpdateDirectionalLightResponse](a00295.xhtml) asset\_preparation::v2::directional\_light::DirectionalLightPreparation::UpdateDirectionalLight  ( [UpdateDirectionalLightRequest](a00291.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