Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    IDirectLight Interface

    Namespace: Stride.Rendering.Lights
    Assembly: Stride.Rendering.dll

    Base interface for all direct lights.

    public interface IDirectLight : IColorLight, ILight
    Name Description
    Properties
    HasBoundingBox

    Gets a value indicating whether this instance has a bounding box.

    Shadow

    Gets or sets the shadow.

    Methods
    ComputeBounds(Vector3, Vector3)

    Computes the bounds of this light..

    ComputeScreenCoverage(RenderView, Vector3, Vector3)

    Computes the screen coverage of this light in pixel.

    | Improve this Doc View Source

    Properties


    HasBoundingBox

    Gets a value indicating whether this instance has a bounding box.

    bool HasBoundingBox { get; }
    Property Value
    Type Description
    System.Boolean

    true if this instance has a bounding box; otherwise, false.


    Shadow

    Gets or sets the shadow.

    LightShadowMap Shadow { get; }
    Property Value
    Type Description
    LightShadowMap

    The shadow.

    | Improve this Doc View Source

    Methods


    ComputeBounds(Vector3, Vector3)

    Computes the bounds of this light..

    BoundingBox ComputeBounds(Vector3 position, Vector3 direction)
    Parameters
    Type Name Description
    Vector3 position

    The position.

    Vector3 direction

    The direction.

    Returns
    Type Description
    BoundingBox

    BoundingBox.


    ComputeScreenCoverage(RenderView, Vector3, Vector3)

    Computes the screen coverage of this light in pixel.

    float ComputeScreenCoverage(RenderView renderView, Vector3 position, Vector3 direction)
    Parameters
    Type Name Description
    RenderView renderView

    The render view.

    Vector3 position

    The position of the light in world space.

    Vector3 direction

    The direction of the light in world space.

    Returns
    Type Description
    System.Single

    The largest screen coverage width or height size in pixels of this light.


    Inherited Members

    IColorLight.Color
    IColorLight.ComputeColor(ColorSpace, Single)
    ILight.Update(RenderLight)

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation