    

 ## On this page

  

 

 # asset\_preparation::v3::surface\_source Namespace Reference

 Last update: 16.07.2025 

## <a name="nested-classes"></a>Classes

struct [BlackBody](structasset__preparation_1_1v3_1_1surface__source_1_1_black_body.xhtml) Spectrum based on a black body. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_black_body.xhtml#details)  
 struct [CreateSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_request.xhtml) The information required to create a surface source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_request.xhtml#details)  
 struct [CreateSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_response.xhtml) The identity of the created surface source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_response.xhtml#details)  
 struct [CreateSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_state_request.xhtml) The information required to create a surface source state. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_state_request.xhtml#details)  
 struct [CreateSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_state_response.xhtml) The response returned when creating a surface source state. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_state_response.xhtml#details)  
 struct [DeleteSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_request.xhtml) The information required to delete a surface source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_request.xhtml#details)  
 struct [DeleteSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_response.xhtml) The response returned when deleting a surface source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_response.xhtml#details)  
 struct [DeleteSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_state_request.xhtml) The information required to delete a surface source state. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_state_request.xhtml#details)  
 struct [DeleteSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_state_response.xhtml) The response returned when deleting a surface source state. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_state_response.xhtml#details)  
 struct [DisplaySourceProperties](structasset__preparation_1_1v3_1_1surface__source_1_1_display_source_properties.xhtml) The properties of a display source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_display_source_properties.xhtml#details)  
 struct [GaussianDiagram](structasset__preparation_1_1v3_1_1surface__source_1_1_gaussian_diagram.xhtml) The properties of gaussian angular diagram. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_gaussian_diagram.xhtml#details)  
 struct [GetSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_request.xhtml) The information required to examine a surface source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_request.xhtml#details)  
 struct [GetSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_response.xhtml) The properties of a surface source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_response.xhtml#details)  
 struct [GetSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_state_request.xhtml) The information required to examine a state. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_state_request.xhtml#details)  
 struct [GetSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_state_response.xhtml) The information about a surface source state. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_state_response.xhtml#details)  
 struct [LambertianDiagram](structasset__preparation_1_1v3_1_1surface__source_1_1_lambertian_diagram.xhtml) Lambertian angular diagram. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_lambertian_diagram.xhtml#details)  
 struct [LibraryDiagram](structasset__preparation_1_1v3_1_1surface__source_1_1_library_diagram.xhtml) The properties of library angular diagram. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_library_diagram.xhtml#details)  
 struct [LightingContribution](structasset__preparation_1_1v3_1_1surface__source_1_1_lighting_contribution.xhtml) Describes how a surface or display source contributes to the scene lighting, including whether the different surfaces composing the geometry must be joint or disjoint. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_lighting_contribution.xhtml#details)  
 struct [ListSurfaceSourcesResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_list_surface_sources_response.xhtml) The identities of all surface sources in the collection. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_list_surface_sources_response.xhtml#details)  
 struct [Monochromatic](structasset__preparation_1_1v3_1_1surface__source_1_1_monochromatic.xhtml) [Monochromatic](structasset__preparation_1_1v3_1_1surface__source_1_1_monochromatic.xhtml "Monochromatic spectrum.") spectrum. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_monochromatic.xhtml#details)  
 struct [Rendering](structasset__preparation_1_1v3_1_1surface__source_1_1_rendering.xhtml) The rendering properties. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_rendering.xhtml#details)  
 struct [Shadows](structasset__preparation_1_1v3_1_1surface__source_1_1_shadows.xhtml) The properties of shadows. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_shadows.xhtml#details)  
 struct [SourceProperties](structasset__preparation_1_1v3_1_1surface__source_1_1_source_properties.xhtml) The source properties. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_source_properties.xhtml#details)  
 struct [SpectrumLibrary](structasset__preparation_1_1v3_1_1surface__source_1_1_spectrum_library.xhtml) Spectrum based on a spectrum file. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_spectrum_library.xhtml#details)  
 struct [SurfaceSourceIdentity](structasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_identity.xhtml) The full identity of a surface source, consisting of an identifier and a name. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_identity.xhtml#details)  
 class [SurfaceSourcePreparation](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml) Surface Source Preparation Service. [More...](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#details)  
 struct [SurfaceSourceProperties](structasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_properties.xhtml) The properties of a surface source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_properties.xhtml#details)  
 struct [UpdateSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_request.xhtml) The information required to update a surface source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_request.xhtml#details)  
 struct [UpdateSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_response.xhtml) The response returned when updating a surface source. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_response.xhtml#details)  
 struct [UpdateSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_state_request.xhtml) The information required to update a surface source state. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_state_request.xhtml#details)  
 struct [UpdateSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_state_response.xhtml) The response returned when updating a surface source state. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_state_response.xhtml#details)  
 struct [Vector3](structasset__preparation_1_1v3_1_1surface__source_1_1_vector3.xhtml) Vector in a 3D referential. [More...](structasset__preparation_1_1v3_1_1surface__source_1_1_vector3.xhtml#details)  
 ## <a name="enum-members"></a>Enumerations

enum [DisjointFluxDistributionType](namespaceasset__preparation_1_1v3_1_1surface__source.xhtml#a6a45da8df827d9f80c88853db7c80001) { [DISTRIBUTION\_TYPE\_UNSPECIFIED](namespaceasset__preparation_1_1v3_1_1surface__source.xhtml#a6a45da8df827d9f80c88853db7c80001a9d1015ac64eec78b49e59a6fd6c454de) = 0, [DISTRIBUTION\_TYPE\_PROPORTIONAL](namespaceasset__preparation_1_1v3_1_1surface__source.xhtml#a6a45da8df827d9f80c88853db7c80001a5d4737529d9884e82e9b04b1acc8a8f5) = 1, [DISTRIBUTION\_TYPE\_EVEN](namespaceasset__preparation_1_1v3_1_1surface__source.xhtml#a6a45da8df827d9f80c88853db7c80001a98fd4b5d203a2a18c3b1115b214cebeb) = 2 } The type of disjoint flux distribution. [More...](namespaceasset__preparation_1_1v3_1_1surface__source.xhtml#a6a45da8df827d9f80c88853db7c80001)  
 ## <a name="var-members"></a>Variables

import google protobuf empty [proto](namespaceasset__preparation_1_1v3_1_1surface__source.xhtml#ab2fe18d41aafdb2a822d9a77b434acaa)## Enumeration Type Documentation

<a id="a6a45da8df827d9f80c88853db7c80001"></a>## [◆ ](#a6a45da8df827d9f80c88853db7c80001)DisjointFluxDistributionType

 enum [asset\_preparation::v3::surface\_source::DisjointFluxDistributionType](namespaceasset__preparation_1_1v3_1_1surface__source.xhtml#a6a45da8df827d9f80c88853db7c80001)

The type of disjoint flux distribution.

Enumerator<a id="a6a45da8df827d9f80c88853db7c80001a9d1015ac64eec78b49e59a6fd6c454de"></a>DISTRIBUTION\_TYPE\_UNSPECIFIED Unspecified disjoint flux distribution type.

<a id="a6a45da8df827d9f80c88853db7c80001a5d4737529d9884e82e9b04b1acc8a8f5"></a>DISTRIBUTION\_TYPE\_PROPORTIONAL Flux distributed proportionally to the area of each disjoint surface.

NoteWith this distribution type, the power emitted by one disjoint surface is equal to the power defined in the surface source properties multiplied by the ratio of area of the disjoint surface to the total area. <a id="a6a45da8df827d9f80c88853db7c80001a98fd4b5d203a2a18c3b1115b214cebeb"></a>DISTRIBUTION\_TYPE\_EVEN Flux distributed evenly among the disjoint surfaces.

NoteWith this distribution type, each disjoint surface emits the same power. The power of each disjoint surface is equal to the power defined in the surface source properties divided by the number of surfaces. 



## Variable Documentation

<a id="ab2fe18d41aafdb2a822d9a77b434acaa"></a>## [◆ ](#ab2fe18d41aafdb2a822d9a77b434acaa)proto

 import google protobuf wrappers asset\_preparation::v3::surface\_source::proto