Struct RenderMeshDescription

Represents how to setup and configure Entities Graphics entities.

Namespace: Unity.Rendering

Assembly: Unity.Entities.Graphics.dll

Syntax

public struct RenderMeshDescription

Remarks

This is useful to convert GameObjects into entities, or to set component values on entities directly.

Constructors

RenderMeshDescription(Renderer)

Construct a RenderMeshDescription using defaults from the given Renderer object.

Declaration

public RenderMeshDescription(Renderer renderer)

Parameters

Type	Name	Description
Renderer	renderer	The renderer object (e.g. a MeshRenderer) to get default settings from.

RenderMeshDescription(ShadowCastingMode, bool, MotionVectorGenerationMode, int, uint, LightProbeUsage, bool)

Construct a RenderMeshDescription using the given values.

Declaration

public RenderMeshDescription(ShadowCastingMode shadowCastingMode, bool receiveShadows = false, MotionVectorGenerationMode motionVectorGenerationMode = MotionVectorGenerationMode.Camera, int layer = 0, uint renderingLayerMask = 4294967295, LightProbeUsage lightProbeUsage = LightProbeUsage.Off, bool staticShadowCaster = false)

Parameters

Type	Name	Description
ShadowCastingMode	shadowCastingMode	Mode for shadow casting
bool	receiveShadows	Mode for shadow receival
MotionVectorGenerationMode	motionVectorGenerationMode	Mode for motion vectors generation
int	layer	Rendering layer
uint	renderingLayerMask	Rendering layer mask
LightProbeUsage	lightProbeUsage	Light probe usage mode
bool	staticShadowCaster	Static shadow caster flag

Fields

FilterSettings

Filtering settings that determine when to draw the entity.

Declaration

public RenderFilterSettings FilterSettings

Field Value

Type	Description
RenderFilterSettings

LightProbeUsage

Determines what kinds of light probes the entity uses, if any.

Declaration

public LightProbeUsage LightProbeUsage

Field Value

Type	Description
LightProbeUsage

Remarks

This value corresponds to LightProbeUsage.