com.io7m.r2.core

## Interface R2SceneLightsGroupType

-     public interface R2SceneLightsGroupType

  A light group to which lights can be added.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `groupID()`
    `<L extends R2LightSingleReadableType> void` | `lightGroupAddSingle(L light, R2ShaderLightSingleUsableType<L> shader)` Add a light to the group.
    `R2SceneLightsClipGroupType` | `lightGroupNewClipGroup(R2InstanceSingleType i)` Retrieve a clip group, creating one if the group does not exist, using the given instance as a clipping volume.

- - ### Method Detail

    - #### groupID

          int groupID()

      Returns:
        The group ID
      See Also:
        `R2Stencils.checkValidGroup(int)`

    - #### lightGroupAddSingle

          <L extends R2LightSingleReadableType> void lightGroupAddSingle(L light,
                                                                         R2ShaderLightSingleUsableType<L> shader)

      Add a light to the group.
      Type Parameters:
        `L` - The precise type of light
      Parameters:
        `light` - The light
        `shader` - The light shader

    - #### lightGroupNewClipGroup

          R2SceneLightsClipGroupType lightGroupNewClipGroup(R2InstanceSingleType i)

      Retrieve a clip group, creating one if the group does not exist, using the given instance as a clipping volume.
      Parameters:
        `i` - The volume
      Returns:
        A new clip group

Copyright © 2017 <code@io7m.com> http://io7m.com