com.io7m.r2.core

## Interface R2SceneStencilsType

- All Known Implementing Classes:
    R2SceneStencils

      public interface R2SceneStencilsType

  The set of stencil instances in a scene.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `stencilsAddSingle(R2InstanceSingleType i)` Add a single instance to the scene.
    `long` | `stencilsCount()`
    `void` | `stencilsExecute(R2SceneStencilsConsumerType c)` Batch the instances and pass them to the given consumer for rendering.
    `R2SceneStencilsMode` | `stencilsGetMode()`
    `void` | `stencilsReset()` Remove all stencil instances from the scene.
    `void` | `stencilsSetMode(R2SceneStencilsMode m)` Set the default stencil mode.

- - ### Method Detail

    - #### stencilsReset

          void stencilsReset()

      Remove all stencil instances from the scene.

    - #### stencilsSetMode

          void stencilsSetMode(R2SceneStencilsMode m)

      Set the default stencil mode.
      Parameters:
        `m` - The mode

    - #### stencilsGetMode

          R2SceneStencilsMode stencilsGetMode()

      Returns:
        The default stencil mode

    - #### stencilsCount

          long stencilsCount()

      Returns:
        The number of stencil instances in the scene

    - #### stencilsAddSingle

          void stencilsAddSingle(R2InstanceSingleType i)

      Add a single instance to the scene.
      Parameters:
        `i` - The instance

    - #### stencilsExecute

          void stencilsExecute(R2SceneStencilsConsumerType c)

      Batch the instances and pass them to the given consumer for rendering.
      Parameters:
        `c` - The consumer

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