com.io7m.r2.core

## Interface R2SceneLightsConsumerType

-     public interface R2SceneLightsConsumerType

  The type of consumers of scene lights.

  Lights are batched in a manner that is intended to require the minimum number of state changes for rendering, based upon the relative cost of state changes.

  See Also:
    `R2SceneOpaquesConsumerType`

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `onFinish()` Called when rendering of lights is finished.
    `void` | `onStart()` Called when rendering of lights begins.
    `R2SceneLightsClipGroupConsumerType` | `onStartClipGroup(R2InstanceSingleType i, int group)` Called when a clip group should be rendered.
    `R2SceneLightsGroupConsumerType` | `onStartGroup(int group)` Called when a group should be rendered.

- - ### Method Detail

    - #### onStart

          void onStart()

      Called when rendering of lights begins.

    - #### onStartClipGroup

          R2SceneLightsClipGroupConsumerType onStartClipGroup(R2InstanceSingleType i,
                                                              int group)

      Called when a clip group should be rendered.
      Parameters:
        `i` - The clipping volume
        `group` - The group number
      Returns:
        A clip group consumer that will receive the contents of the group

    - #### onStartGroup

          R2SceneLightsGroupConsumerType onStartGroup(int group)

      Called when a group should be rendered.
      Parameters:
        `group` - The group number
      Returns:
        A group consumer that will receive the contents of the group

    - #### onFinish

          void onFinish()

      Called when rendering of lights is finished.

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