 | LensFlare Class |
Inheritance HierarchyNamespace: DigitalRune.Graphics
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)
SyntaxThe LensFlare type exposes the following members.
ConstructorsMethods| Name | Description | |
|---|---|---|
 | Clone |
Creates a new LensFlare that is a clone (deep copy) of the current instance.
|
 | CloneCore |
Makes the instance a clone (deep copy) of the specified LensFlare.
|
| CreateInstanceCore |
When implemented in a derived class, creates a new instance of the LensFlare
derived class.
|
| Equals | (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnGetSizeAndIntensity |
Called when the size and intensity of a lens flare is determined.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | Elements |
Gets the elements of the lens flare.
|
| Intensity |
Gets or sets the intensity of the lens flare.
|
| IsDirectional |
Gets a value indicating whether the lens flare is caused by a directional light, such as the
sun. (Directional lights are treated as if placed at an infinite distance. See remarks.)
|
| Name |
Gets or sets the name of the lens flare effect.
|
| QuerySize |
Gets or sets the size of the lens flare used in the occlusion query. See remarks.
|
| Size |
Gets or sets the height of the lens flare relative to the viewport.
|
RemarksA lens flare is an effect caused by a camera lens when looking at bright light. A lens flare usually consists of multiple elements which move across the screen depending on the position of the light source: bloom and halo around the light source, light streaks, secondary rings, hexagonal patterns caused by the lens' aperture blades. The elements (e.g. a ring, a halo) is defined by creating a LensFlareElement and adding it to the Elements collection.
A LensFlareNode needs to be created to define the position and orientation of a lens flare within a 3D scene.
The property IsDirectional defines whether the light is caused by a directional light (such as the sun) or a local light source. The light direction is defined by the forward direction of the LensFlareNode.
Cloning:
LensFlares are cloneable. When Clone is called all properties
including the Elements are duplicated (deep copy).
See Also