diff --git a/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Features.md b/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Features.md index ce5745e9da6..8ec0b07d7cf 100644 --- a/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Features.md +++ b/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Features.md @@ -172,7 +172,7 @@ HDRP supports the Illuminating Engineering Society's (IES) file format for descr ![](Images/LensFlareSamples2.png) From HDRP 12.0, HDRP (and URP) introduces a new Lens Flare system. You can attach a Lens Flare (SRP) component to any GameObject. -Some Lens Flare properties only appear when you attach this component to a light. Each Lens Flare can have multiple elements that you can control individually. HDRP also provides a [new asset](lens-flare-data-driven-asset.md) and a [new component](lens-flare-data-driven-component.md) which you can attach to any GameObject. +Some Lens Flare properties only appear when you attach this component to a light. Each Lens Flare can have multiple elements that you can control individually. HDRP also provides a [new asset](shared/lens-flare/lens-flare-asset.md) and a [new component](shared/lens-flare/lens-flare-component.md) which you can attach to any GameObject. ### Reflection probes diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareShapeCircle.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareShapeCircle.png deleted file mode 100644 index 7ec56363448..00000000000 --- a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareShapeCircle.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:2c9ce5e561ac42b3111771a49390468a0cca863a1f47178285e07e5ffae06be7 -size 4800 diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareShapePolygon.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareShapePolygon.png deleted file mode 100644 index 8b7b91df035..00000000000 --- a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareShapePolygon.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:1e80f5f3df7c56974fa140c772784f39f40edc3ac3d7754f5d978e4dbfdf9bbb -size 7673 diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareTransform.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareTransform.png deleted file mode 100644 index 57eb60af46d..00000000000 --- a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareTransform.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:f5b6c8b789a706313a9f6604692a18dc0148a4e401b32207844ba6bd434ef231 -size 7252 diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareAxisTransform.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-axis-transform.png similarity index 100% rename from com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareAxisTransform.png rename to com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-axis-transform.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareColor.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-color.png similarity index 100% rename from com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareColor.png rename to com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-color.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareComp.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-comp.png similarity index 100% rename from com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareComp.png rename to com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-comp.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareHeader.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-header.png similarity index 100% rename from com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareHeader.png rename to com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-header.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareMultileElementCurve.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-curve.png similarity index 100% rename from com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareMultileElementCurve.png rename to com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-curve.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareMultileElementRandom.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-random.png similarity index 100% rename from com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareMultileElementRandom.png rename to com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-random.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareMultileElementUniform.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-uniform.png similarity index 100% rename from com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareMultileElementUniform.png rename to com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-uniform.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareRadialDistortion.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-radial-distortion.png similarity index 100% rename from com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareRadialDistortion.png rename to com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-radial-distortion.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-shape-circle.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-shape-circle.png new file mode 100644 index 00000000000..691cc01c854 --- /dev/null +++ b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-shape-circle.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b07ff1308cfd182e75fce0f7fda3ee223f842cf3690b7708f5f9f17e8e631aea +size 4454 diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareShapeImage.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-shape-image.png similarity index 100% rename from com.unity.render-pipelines.high-definition/Documentation~/Images/LensFlareShapeImage.png rename to com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-shape-image.png diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-shape-polygon.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-shape-polygon.png new file mode 100644 index 00000000000..9d8a4086684 --- /dev/null +++ b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-shape-polygon.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5bda603c5dbe15d78b069c6b7da23f2d262876a53ab24aff8c16be295bade6d0 +size 6803 diff --git a/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-transform.png b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-transform.png new file mode 100644 index 00000000000..d341836779c --- /dev/null +++ b/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lens-flare-transform.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a7df658c8c7ce32d2ffe5b2169b3eba5a03535fa483a88074ff297a9826515a4 +size 6686 diff --git a/com.unity.render-pipelines.high-definition/Documentation~/TableOfContents.md b/com.unity.render-pipelines.high-definition/Documentation~/TableOfContents.md index 84b1dc76be3..c6132a0f7bd 100644 --- a/com.unity.render-pipelines.high-definition/Documentation~/TableOfContents.md +++ b/com.unity.render-pipelines.high-definition/Documentation~/TableOfContents.md @@ -184,6 +184,8 @@ * [Debugging Ray-Traced Effects](Ray-Tracing-Debug.md) * Components * [Decal Projector](Decal-Projector.md) + * [Lens Flare](shared/lens-flare/lens-flare-component.md) + * [Lens Flare asset](shared/lens-flare/lens-flare-asset.md) * Tools * [Look Dev](Look-Dev.md) * [Compositor](Compositor-Main.md) diff --git a/com.unity.render-pipelines.high-definition/Documentation~/lens-flare-data-driven-asset.md b/com.unity.render-pipelines.high-definition/Documentation~/shared/lens-flare/lens-flare-asset.md similarity index 88% rename from com.unity.render-pipelines.high-definition/Documentation~/lens-flare-data-driven-asset.md rename to com.unity.render-pipelines.high-definition/Documentation~/shared/lens-flare/lens-flare-asset.md index 7e2e3839887..ba90c3b44ff 100644 --- a/com.unity.render-pipelines.high-definition/Documentation~/lens-flare-data-driven-asset.md +++ b/com.unity.render-pipelines.high-definition/Documentation~/shared/lens-flare/lens-flare-asset.md @@ -1,8 +1,8 @@ -[comment]: # (If you modify this file make sure you modify the copy/paste file: com.unity.render-pipelines.universal and com.unity.render-pipelines.core\Documentation~\Common\lens-flare-data-driven-asset.md) +# Lens Flare (SRP) Data Asset -# Lens Flare (SRP) Asset +Unity’s [Scriptable Render Pipeline (SRP)](https://docs.unity3d.com/Manual/ScriptableRenderPipeline.html) includes the **Lens Flare Data** asset. You can use this asset to control the appearance of [Lens Flares](lens-flare-component.md) in your scene. This is the SRP equivalent of the Built-in Render Pipeline's [Flare](https://docs.unity3d.com/Manual/class-Flare.html) asset, which is incompatible with SRPs. -Unity’s [Scriptable Render Pipeline (SRP)](https://docs.unity3d.com/Manual/ScriptableRenderPipeline.html) includes the **Lens Flare Element** asset. You can use this asset to create lens flares in your scene and control their appearance.
To create a Lens Flare Element asset, navigate to **Assets > Create > SRP Lens Flare**. To use this asset, assign it to the **Lens Flare Data** property of an [SRP Lens Flare Override Component](srp-lens-flare-component.md). +To create a Lens Flare Data asset, select **Assets > Create > Lens Flare (SRP)**. To use this asset, assign it to the **Lens Flare Data** property of a [Lens Flare (SRP) component](lens-flare-component.md). ## Properties @@ -32,7 +32,7 @@ The Lens Flare Element asset has the following properties: #### Image -![](images/LensFlareShapeImage.png) +![](../../images/shared/lens-flare/lens-flare-shape-image.png) | **Property** | **Description** | | --------------------- | ------------------------------------------------------------ | @@ -43,7 +43,7 @@ The Lens Flare Element asset has the following properties: #### Circle -![](images/LensFlareShapeCircle.png) +![](../../images/shared/lens-flare/lens-flare-shape-circle.png) | **Property** | **Description** | | ------------ | ------------------------------------------------------------ | @@ -55,7 +55,7 @@ The Lens Flare Element asset has the following properties: #### Polygon -![](images/LensFlareShapePolygon.png) +![](../../images/shared/lens-flare/lens-flare-shape-polygon.png) | **Property** | **Description** | | ------------ | ------------------------------------------------------------ | @@ -69,12 +69,12 @@ The Lens Flare Element asset has the following properties: ## Color -![](images/LensFlareColor.png) +![](../../images/shared/lens-flare/lens-flare-Color.png) | **Property** | **Description** | | ----------------------- | ------------------------------------------------------------ | | Tint | Changes the tint of the lens flare. If this asset is attached to the light, this property is based on the light tint. | -| Modulate By Light Color | Allows light color to affect this Lens Flare Element. This only applies when the asset is used in a [SRP Lens Flare Override Component](srp-lens-flare-component.md) that is attached to a point, spot, or area light. | +| Modulate By Light Color | Allows light color to affect this Lens Flare Element. This only applies when the asset is used in a [Lens Flare (SRP) component](lens-flare-component.md) that is attached to a point, spot, or area light. | | Intensity | Controls the intensity of this element. | | Blend Mode | Select the blend mode of the Lens Flare Element this asset creates:
• Additive
• Screen
• Premultiplied
• Lerp | @@ -82,7 +82,7 @@ The Lens Flare Element asset has the following properties: ## Transform -![](images/LensFlareTransform.png) +![](../../images/shared/lens-flare/lens-flare-Transform.png) | **Property** | **Description** | | ----------------------- | ------------------------------------------------------------ | @@ -97,7 +97,7 @@ The Lens Flare Element asset has the following properties: ## AxisTransform -![](images/LensFlareAxisTransform.png) +![](../../images/shared/lens-flare/lens-flare-axis-transform.png) | **Property** | **Description** | | ----------------- | ------------------------------------------------------------ | @@ -109,7 +109,7 @@ The Lens Flare Element asset has the following properties: ## Distortion -![](images/LensFlareRadialDistortion.png) +![](../../images/shared/lens-flare/lens-flare-radial-distortion.png) | **Property** | **Description** | | --------------- | ------------------------------------------------------------ | @@ -131,7 +131,7 @@ The Lens Flare Element asset has the following properties: | Relative To Center | If true the distortion is relative to center of the screen otherwise relative to lensFlare source screen position. | ### Uniform -![](images/LensFlareMultileElementUniform.png) +![](../../images/shared/lens-flare/lens-flare-multiple-elements-uniform.png) | **Property** | **Description** | | --------------- | ------------------------------------------------------------ | @@ -142,7 +142,7 @@ The Lens Flare Element asset has the following properties: ### Curve -![](images/LensFlareMultileElementCurve.png) +![](../../images/shared/lens-flare/lens-flare-multiple-elements-curve.png) | **Property** | **Description** | | ---------------- | ------------------------------------------------------------ | @@ -155,7 +155,7 @@ The Lens Flare Element asset has the following properties: ### Random -![](images/LensFlareMultileElementRandom.png) +![](../../images/shared/lens-flare/lens-flare-multiple-elements-random.png) | **Property** | **Description** | | ------------------- | ------------------------------------------------------------ | diff --git a/com.unity.render-pipelines.high-definition/Documentation~/lens-flare-data-driven-component.md b/com.unity.render-pipelines.high-definition/Documentation~/shared/lens-flare/lens-flare-component.md similarity index 54% rename from com.unity.render-pipelines.high-definition/Documentation~/lens-flare-data-driven-component.md rename to com.unity.render-pipelines.high-definition/Documentation~/shared/lens-flare/lens-flare-component.md index d9af11992e9..56c03e1d0f2 100644 --- a/com.unity.render-pipelines.high-definition/Documentation~/lens-flare-data-driven-component.md +++ b/com.unity.render-pipelines.high-definition/Documentation~/shared/lens-flare/lens-flare-component.md @@ -1,13 +1,23 @@ -[comment]: # (If you modify this file make sure you modify the copy/paste file: com.unity.render-pipelines.universal and com.unity.render-pipelines.core\Documentation~\Common\lens-flare-data-driven-component.md) +# Lens Flare (SRP) component -# Lens Flare (SRP) Component +![](../../images/shared/lens-flare/lens-flare-header.png) -![](images/LensFlareHeader.png) +Unity’s Scriptable Render Pipeline (SRP) includes the Lens Flare (SRP) component which renders a lens flare in your scene. This is the SRP equivalent of the Built-in Render Pipeline's [Lens Flare](https://docs.unity3d.com/Manual/class-LensFlare.html) component, which is incompatible with SRPs. You can attach a Lens Flare (SRP) component to any GameObject, but some properties only appear when you attach a Lens Flare (SRP) component to a light. -Unity’s Scriptable Render Pipeline (SRP) includes the SRP Lens Flare Override component to control a [Lens Flare (SRP) Data](lens-flare-data-driven-asset.md) asset. You can attach an Lens Flare (SRP) Component to any GameObject. -Some properties only appear when you attach this component to a light. +![](../../images/shared/lens-flare/lens-flare-comp.png) -![](images/LensFlareComp.png) +## Creating lens flares in SRP + +The Lens Flare (SRP) component controls where the lens flare is as well as properties such as attenuation and whether the lens flare considers occlusion. For properties that define how the lens flare looks, SRP uses the [Lens Flare (SRP) Data](lens-flare-asset.md) asset. Each Lens Flare (SRP) component must reference a Lens Flare (SRP) data asset to display a lens flare on-screen. + +To create a lens flare in a scene: + +1. Create or select a GameObject to attach the lens flare to. +2. In the Inspector, click **Add Component**. +3. Select **Rendering** > **Lens Flare (SRP)**. Currently, the lens flare doesn't render in the scene because the component doesn't reference a Lens Flare (SRP) Data asset in its **Lens Flare Data** property. +4. Create a new Lens Flare (SRP) Data asset (menu: **Assets** > **Create** > **Lens Flare (SRP)**). +5. In the Lens Flare (SRP) component Inspector, assign the new Lens Flare (SRP) Data asset to the **Lens Flare Data** property. +6. Select the Lens Flare (SRP) Data asset and, in the Inspector, add a new element to the **Elements** list. A default white lens flare now renders at the position of the Lens Flare (SRP) component. For information on how to customize how the lens flare looks, see [Lens Flare (SRP) Data](lens-flare-asset.md). ## Properties @@ -15,7 +25,7 @@ Some properties only appear when you attach this component to a light. | **Property** | **Description** | | --------------- | ------------------------------------------------------------ | -| Lens Flare Data | Select the [Lens Flare (SRP) Asset](lens-flare-data-driven-asset.md) asset this component controls. | +| Lens Flare Data | Select the [Lens Flare (SRP) Data](lens-flare-asset.md) asset this component controls. | | Intensity | Multiplies the intensity of the lens flare. | | Scale | Multiplies the scale of the lens flare. | | Attenuation by Light Shape | Enable this property to automatically change the appearance of the lens flare based on the type of light you attached this component to.
For example, if this component is attached to a spot light and the camera is looking at this light from behind, the lens flare will not be visible.
This property is only available when this component is attached to a light. | diff --git a/com.unity.render-pipelines.high-definition/Documentation~/whats-new-12.md b/com.unity.render-pipelines.high-definition/Documentation~/whats-new-12.md index e425ad1906d..78a8b9fa9bb 100644 --- a/com.unity.render-pipelines.high-definition/Documentation~/whats-new-12.md +++ b/com.unity.render-pipelines.high-definition/Documentation~/whats-new-12.md @@ -39,7 +39,7 @@ For detailed steps on how to create custom clouds in your scene, see [creating c HDRP 12.0 includes a new Lens Flare system. You can attach a Lens Flare (SRP) component to any GameObject. -Some Lens Flare properties only appear when you attach a Lens Flare (SRP) component to a light. Each Lens Flare has optional multiple elements that you can control individually. HDRP also provides a [new lens flare asset](lens-flare-data-driven-asset.md) and a [new lens flare component](lens-flare-data-driven-component.md) that you can attach to any GameObject. +Some Lens Flare properties only appear when you attach a Lens Flare (SRP) component to a light. Each Lens Flare has optional multiple elements that you can control individually. HDRP also provides a [new lens flare asset](shared/lens-flare/lens-flare-asset.md) and a [new lens flare component](shared/lens-flare/lens-flare-component.md) that you can attach to any GameObject. ### Light Anchor diff --git a/com.unity.render-pipelines.universal/Documentation~/EffectList.md b/com.unity.render-pipelines.universal/Documentation~/EffectList.md index b19faf3c396..8fba4e6f902 100644 --- a/com.unity.render-pipelines.universal/Documentation~/EffectList.md +++ b/com.unity.render-pipelines.universal/Documentation~/EffectList.md @@ -36,4 +36,4 @@ These are the post-processing effects that are available in the Universal Render * [White Balance](Post-Processing-White-Balance.md) -* [Lens Flare Data Driven](lens-flare-data-driven-component.md) +* [Lens Flare](lens-flare-component.md) diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareShapeCircle.png b/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareShapeCircle.png deleted file mode 100644 index 7ec56363448..00000000000 --- a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareShapeCircle.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:2c9ce5e561ac42b3111771a49390468a0cca863a1f47178285e07e5ffae06be7 -size 4800 diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareShapePolygon.png b/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareShapePolygon.png deleted file mode 100644 index 8b7b91df035..00000000000 --- a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareShapePolygon.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:1e80f5f3df7c56974fa140c772784f39f40edc3ac3d7754f5d978e4dbfdf9bbb -size 7673 diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareTransform.png b/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareTransform.png deleted file mode 100644 index 57eb60af46d..00000000000 --- a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareTransform.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:f5b6c8b789a706313a9f6604692a18dc0148a4e401b32207844ba6bd434ef231 -size 7252 diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareAxisTransform.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-axis-transform.png similarity index 100% rename from com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareAxisTransform.png rename to com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-axis-transform.png diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareColor.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-color.png similarity index 100% rename from com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareColor.png rename to com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-color.png diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareComp.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-comp.png similarity index 100% rename from com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareComp.png rename to com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-comp.png diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareHeader.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-header.png similarity index 100% rename from com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareHeader.png rename to com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-header.png diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareMultileElementCurve.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-curve.png similarity index 100% rename from com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareMultileElementCurve.png rename to com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-curve.png diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareMultileElementRandom.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-random.png similarity index 100% rename from com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareMultileElementRandom.png rename to com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-random.png diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareMultileElementUniform.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-uniform.png similarity index 100% rename from com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareMultileElementUniform.png rename to com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-multiple-elements-uniform.png diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareRadialDistortion.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-radial-distortion.png similarity index 100% rename from com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareRadialDistortion.png rename to com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-radial-distortion.png diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-shape-circle.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-shape-circle.png new file mode 100644 index 00000000000..691cc01c854 --- /dev/null +++ b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-shape-circle.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b07ff1308cfd182e75fce0f7fda3ee223f842cf3690b7708f5f9f17e8e631aea +size 4454 diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareShapeImage.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-shape-image.png similarity index 100% rename from com.unity.render-pipelines.universal/Documentation~/Images/lighting/LensFlareShapeImage.png rename to com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-shape-image.png diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-shape-polygon.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-shape-polygon.png new file mode 100644 index 00000000000..9d8a4086684 --- /dev/null +++ b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-shape-polygon.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5bda603c5dbe15d78b069c6b7da23f2d262876a53ab24aff8c16be295bade6d0 +size 6803 diff --git a/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-transform.png b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-transform.png new file mode 100644 index 00000000000..d341836779c --- /dev/null +++ b/com.unity.render-pipelines.universal/Documentation~/Images/shared/lens-flare/lens-flare-transform.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a7df658c8c7ce32d2ffe5b2169b3eba5a03535fa483a88074ff297a9826515a4 +size 6686 diff --git a/com.unity.render-pipelines.universal/Documentation~/TableOfContents.md b/com.unity.render-pipelines.universal/Documentation~/TableOfContents.md index c4d5eb3aa07..6e9a9041794 100644 --- a/com.unity.render-pipelines.universal/Documentation~/TableOfContents.md +++ b/com.unity.render-pipelines.universal/Documentation~/TableOfContents.md @@ -38,6 +38,7 @@ * [The Universal Additional Light Data component](universal-additional-light-data.md) * [Shadows in the Universal Render Pipeline](Shadows-in-URP.md) * [Reflection probes](lighting/reflection-probes.md) + * [Lens Flare asset](shared/lens-flare/lens-flare-asset.md) * [Cameras](cameras.md) * [The Universal Additional Camera Data component](universal-additional-camera-data.md) * [Render Type](camera-types-and-render-type.md) @@ -71,7 +72,7 @@ * [Tonemapping](post-processing-tonemapping.md) * [Vignette](post-processing-vignette.md) * [White Balance](Post-Processing-White-Balance.md) - * [Lens Flare Data Driven](lens-flare-data-driven-component.md) + * [Lens Flare](shared/lens-flare/lens-flare-component.md) * [Shaders and Materials](shaders-in-universalrp.md) * [Shading Models](shading-model.md) diff --git a/com.unity.render-pipelines.universal/Documentation~/lens-flare-data-driven-asset.md b/com.unity.render-pipelines.universal/Documentation~/shared/lens-flare/lens-flare-asset.md similarity index 87% rename from com.unity.render-pipelines.universal/Documentation~/lens-flare-data-driven-asset.md rename to com.unity.render-pipelines.universal/Documentation~/shared/lens-flare/lens-flare-asset.md index d769811fb39..ba90c3b44ff 100644 --- a/com.unity.render-pipelines.universal/Documentation~/lens-flare-data-driven-asset.md +++ b/com.unity.render-pipelines.universal/Documentation~/shared/lens-flare/lens-flare-asset.md @@ -1,8 +1,8 @@ -[comment]: # (If you modify this file make sure you modify the copy/paste file: com.unity.render-pipelines.high-definition and com.unity.render-pipelines.core\Documentation~\Common\lens-flare-data-driven-asset.md) +# Lens Flare (SRP) Data Asset -# Lens Flare (SRP) Asset +Unity’s [Scriptable Render Pipeline (SRP)](https://docs.unity3d.com/Manual/ScriptableRenderPipeline.html) includes the **Lens Flare Data** asset. You can use this asset to control the appearance of [Lens Flares](lens-flare-component.md) in your scene. This is the SRP equivalent of the Built-in Render Pipeline's [Flare](https://docs.unity3d.com/Manual/class-Flare.html) asset, which is incompatible with SRPs. -Unity’s [Scriptable Render Pipeline (SRP)](https://docs.unity3d.com/Manual/ScriptableRenderPipeline.html) includes the **Lens Flare Element** asset. You can use this asset to create lens flares in your scene and control their appearance.
To create a Lens Flare Element asset, navigate to **Assets > Create > SRP Lens Flare**. To use this asset, assign it to the **Lens Flare Data** property of an [SRP Lens Flare Override Component](srp-lens-flare-component.md). +To create a Lens Flare Data asset, select **Assets > Create > Lens Flare (SRP)**. To use this asset, assign it to the **Lens Flare Data** property of a [Lens Flare (SRP) component](lens-flare-component.md). ## Properties @@ -32,7 +32,7 @@ The Lens Flare Element asset has the following properties: #### Image -![](images/lighting/LensFlareShapeImage.png) +![](../../images/shared/lens-flare/lens-flare-shape-image.png) | **Property** | **Description** | | --------------------- | ------------------------------------------------------------ | @@ -43,7 +43,7 @@ The Lens Flare Element asset has the following properties: #### Circle -![](images/lighting/LensFlareShapeCircle.png) +![](../../images/shared/lens-flare/lens-flare-shape-circle.png) | **Property** | **Description** | | ------------ | ------------------------------------------------------------ | @@ -55,7 +55,7 @@ The Lens Flare Element asset has the following properties: #### Polygon -![](images/lighting/LensFlareShapePolygon.png) +![](../../images/shared/lens-flare/lens-flare-shape-polygon.png) | **Property** | **Description** | | ------------ | ------------------------------------------------------------ | @@ -69,12 +69,12 @@ The Lens Flare Element asset has the following properties: ## Color -![](images/lighting/LensFlareColor.png) +![](../../images/shared/lens-flare/lens-flare-Color.png) | **Property** | **Description** | | ----------------------- | ------------------------------------------------------------ | | Tint | Changes the tint of the lens flare. If this asset is attached to the light, this property is based on the light tint. | -| Modulate By Light Color | Allows light color to affect this Lens Flare Element. This only applies when the asset is used in a [SRP Lens Flare Override Component](srp-lens-flare-component.md) that is attached to a point, spot, or area light. | +| Modulate By Light Color | Allows light color to affect this Lens Flare Element. This only applies when the asset is used in a [Lens Flare (SRP) component](lens-flare-component.md) that is attached to a point, spot, or area light. | | Intensity | Controls the intensity of this element. | | Blend Mode | Select the blend mode of the Lens Flare Element this asset creates:
• Additive
• Screen
• Premultiplied
• Lerp | @@ -82,7 +82,7 @@ The Lens Flare Element asset has the following properties: ## Transform -![](images/lighting/LensFlareTransform.png) +![](../../images/shared/lens-flare/lens-flare-Transform.png) | **Property** | **Description** | | ----------------------- | ------------------------------------------------------------ | @@ -97,7 +97,7 @@ The Lens Flare Element asset has the following properties: ## AxisTransform -![](images/lighting/LensFlareAxisTransform.png) +![](../../images/shared/lens-flare/lens-flare-axis-transform.png) | **Property** | **Description** | | ----------------- | ------------------------------------------------------------ | @@ -109,7 +109,7 @@ The Lens Flare Element asset has the following properties: ## Distortion -![](images/lighting/LensFlareRadialDistortion.png) +![](../../images/shared/lens-flare/lens-flare-radial-distortion.png) | **Property** | **Description** | | --------------- | ------------------------------------------------------------ | @@ -131,7 +131,7 @@ The Lens Flare Element asset has the following properties: | Relative To Center | If true the distortion is relative to center of the screen otherwise relative to lensFlare source screen position. | ### Uniform -![](images/lighting/LensFlareMultileElementUniform.png) +![](../../images/shared/lens-flare/lens-flare-multiple-elements-uniform.png) | **Property** | **Description** | | --------------- | ------------------------------------------------------------ | @@ -142,20 +142,20 @@ The Lens Flare Element asset has the following properties: ### Curve -![](images/lighting/LensFlareMultileElementCurve.png) +![](../../images/shared/lens-flare/lens-flare-multiple-elements-curve.png) | **Property** | **Description** | | ---------------- | ------------------------------------------------------------ | | Colors | The range of colors that this asset applies to the lens flares. You can use the **Position Spacing** curve to determine how this range affects each lens flare. | | Position Variation | Adjust this curve to change the placement of the lens flare elements in the **Lens Spread**. | -| Rotation | The uniform angle of rotation (in degrees) applied to each element distributed along the curve. This value ranges from -180° to 180 | +| Rotation | The uniform angle of rotation (in degrees) applied to each element distributed along the curve. This value ranges from -180° to 180°. | | Scale | Adjust this curve to control the size range of the lens flare elements. | ### Random -![](images/lighting/LensFlareMultileElementRandom.png) +![](../../images/shared/lens-flare/lens-flare-multiple-elements-random.png) | **Property** | **Description** | | ------------------- | ------------------------------------------------------------ | diff --git a/com.unity.render-pipelines.universal/Documentation~/lens-flare-data-driven-component.md b/com.unity.render-pipelines.universal/Documentation~/shared/lens-flare/lens-flare-component.md similarity index 54% rename from com.unity.render-pipelines.universal/Documentation~/lens-flare-data-driven-component.md rename to com.unity.render-pipelines.universal/Documentation~/shared/lens-flare/lens-flare-component.md index 3bfdf249cb7..4cd6ee9bdce 100644 --- a/com.unity.render-pipelines.universal/Documentation~/lens-flare-data-driven-component.md +++ b/com.unity.render-pipelines.universal/Documentation~/shared/lens-flare/lens-flare-component.md @@ -1,13 +1,23 @@ -[comment]: # (If you modify this file make sure you modify the copy/paste file: com.unity.render-pipelines.high-definition and com.unity.render-pipelines.core\Documentation~\Common\lens-flare-data-driven-component.md) +# Lens Flare (SRP) component -# Lens Flare (SRP) Component +![](../../images/shared/lens-flare/lens-flare-header.png) -![](images/lighting/LensFlareHeader.png) +Unity’s Scriptable Render Pipeline (SRP) includes the Lens Flare (SRP) component which renders a lens flare in your scene. This is the SRP equivalent of the Built-in Render Pipeline's [Lens Flare](https://docs.unity3d.com/Manual/class-LensFlare.html) component, which is incompatible with SRPs. You can attach a Lens Flare (SRP) component to any GameObject, but some properties only appear when you attach a Lens Flare (SRP) component to a light. -Unity’s Scriptable Render Pipeline (SRP) includes the SRP Lens Flare Override component to control a [Lens Flare (SRP) Data](lens-flare-data-driven-asset.md) asset. You can attach an Lens Flare (SRP) Component to any GameObject. -Some properties only appear when you attach this component to a light. +![](../../images/shared/lens-flare/lens-flare-comp.png) -![](images/lighting/LensFlareComp.png) +## Creating lens flares in SRP + +The Lens Flare (SRP) component controls where the lens flare is as well as properties such as attenuation and whether the lens flare considers occlusion. For properties that define how the lens flare looks, SRP uses the [Lens Flare (SRP) Data](lens-flare-asset.md) asset. Each Lens Flare (SRP) component must reference a Lens Flare (SRP) data asset to display a lens flare on-screen. + +To create a lens flare in a scene: + +1. Create or select a GameObject to attach the lens flare too. +2. In the Inspector, click **Add Component**. +3. Select **Rendering** > **Lens Flare (SRP)**. Currently, the lens flare doesn't render in the scene because the component doesn't reference a Lens Flare (SRP) Data asset in its **Lens Flare Data** property. +4. Create a new Lens Flare (SRP) Data asset (menu: **Assets** > **Create** > **Lens Flare (SRP)**). +5. In the Lens Flare (SRP) component Inspector, assign the new Lens Flare (SRP) Data asset to the **Lens Flare Data** property. +6. Select the Lens Flare (SRP) Data asset and, in the Inspector, add a new element to the **Elements** list. A default white lens flare now renders at the position of the Lens Flare (SRP) component. For information on how to customize how the lens flare looks, see [Lens Flare (SRP) Data](lens-flare-asset.md). ## Properties @@ -15,7 +25,7 @@ Some properties only appear when you attach this component to a light. | **Property** | **Description** | | --------------- | ------------------------------------------------------------ | -| Lens Flare Data | Select the [Lens Flare (SRP) Asset](lens-flare-data-driven-asset.md) asset this component controls. | +| Lens Flare Data | Select the [Lens Flare (SRP) Data](lens-flare-asset.md) asset this component controls. | | Intensity | Multiplies the intensity of the lens flare. | | Scale | Multiplies the scale of the lens flare. | | Attenuation by Light Shape | Enable this property to automatically change the appearance of the lens flare based on the type of light you attached this component to.
For example, if this component is attached to a spot light and the camera is looking at this light from behind, the lens flare will not be visible.
This property is only available when this component is attached to a light. |