SceneLightingEffect Class

Definition

Namespace:

Microsoft.UI.Composition.Effects

Controls the reflective properties of a SpriteVisual. A SceneLightingEffect will overwrite CompositionLight defaults. It is used to control the reflective properties of a SpriteVisual. A NormalMap can be used as an input source but is not required.

public ref class SceneLightingEffect sealed : IGraphicsEffect

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Foundation.WindowsAppSDKContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
class SceneLightingEffect final : IGraphicsEffect

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Foundation.WindowsAppSDKContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
public sealed class SceneLightingEffect : IGraphicsEffect

function SceneLightingEffect()

Public NotInheritable Class SceneLightingEffect
Implements IGraphicsEffect

Inheritance

Object Platform::Object IInspectable SceneLightingEffect

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

IGraphicsEffect IGraphicsEffectSource

Examples

IGraphicsEffect graphicsEffect = new CompositeEffect() 
{ 
  Mode = CanvasComposite.Add, 
  Sources = 
  { 
    new CompositionEffectSourceParameter("ImageSource"), 
    new SceneLightingEffect() 
    { 
      Name = "Material",                                     
      AmbientAmount = 0, 
      DiffuseAmount = .75f, 
      SpecularAmount = 0, 
      SpecularShine = 20 
      NormalMapSource = new CompositionEffectSourceParameter("NormalMap"), 
    } 
  } 
}; 

Constructors

SceneLightingEffect()

Creates an instance of SceneLightingEffect.

Properties

AmbientAmount	The proportion of predefined AmbientLight used by the effect.
DiffuseAmount	Intensity of the diffuse light.
Name	Name of the light.
NormalMapSource	The normal map for the effect.
ReflectanceModel	Gets or sets a value that indicates how the reflectance of a SceneLightingEffect is modeled.
SpecularAmount	Intensity of the specular light.
SpecularShine	Specular power for the Blinn-Phong lighting model.

See also

• CompositionLight
• Targets
• CreateAmbientLight()
• CreateDistantLight()
• CreatePointLight()