/*
 * Copyright 2009, Google Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace o3d {

%[
  A ClearBuffer is a render node that clears the color buffer, zbuffer and/or
  stencil buffer of the current render target.

  @o3dparameter clearColor ParamFloat4 The color to clear to.
  @o3dparameter clearColorFloat ParamBoolean True to clear the color of the
      current render target.
  @o3dparameter clearColor ParamFloat The depth value to clear to (0.0 to 1.0).
  @o3dparameter clearColorFloat ParamBoolean True to clear the depth of the
      current render target.
  @o3dparameter clearColor ParamInteger The stencil value to clear to.
  @o3dparameter clearColorFloat ParamBoolean True to clear the stencil of the
      current render target.
%]

[nocpp, include="core/cross/clear_buffer.h"] class ClearBuffer
    : RenderNode {
  %[
    The color to clear the buffer in RGBA Float4 format.
  %]
  [getter, setter] Float4 clear_color;

  %[
    true clears the current render target's color buffer to the clear color.
    false does not clear the color buffer.
  %]
  [getter, setter] bool clear_color_flag_;

  %[
    The value to clear the depth buffer (0.0 to 1.0)
  %]
  [getter, setter] float clear_depth_;

  %[
    true clears the current render target's depth buffer to the clear depth
    value. false does not clear the depth buffer.
  %]
  [getter, setter] bool clear_depth_flag_;

  %[
    The value to clear the stencil buffer to (0 - 255).
  %]
  [getter, setter] int clear_stencil_;

  %[
    true clears the current render target's stencil buffer to the clear stencil
    value. false does not clear the stencil buffer
  %]
  [getter, setter] bool clear_stencil_flag_;

};  // ClearBuffer

}  // namespace o3d