painter_shader_group.hpp

Go to the documentation of this file.

/*!
 * \file painter_shader_group.hpp
 * \brief file painter_shader_group.hpp
 *
 * Copyright 2016 by Intel.
 *
 * Contact: kevin.rogovin@gmail.com
 *
 * This Source Code Form is subject to the
 * terms of the Mozilla Public License, v. 2.0.
 * If a copy of the MPL was not distributed with
 * this file, You can obtain one at
 * http://mozilla.org/MPL/2.0/.
 *
 * \author Kevin Rogovin <kevin.rogovin@gmail.com>
 *
 */

#ifndef FASTUIDRAW_PAINTER_SHADER_GROUP_HPP
#define FASTUIDRAW_PAINTER_SHADER_GROUP_HPP

#include <stdint.h>
#include <fastuidraw/util/blend_mode.hpp>
#include <fastuidraw/painter/shader/painter_blend_shader.hpp>

namespace fastuidraw
{
/*!\addtogroup PainterBackend
 * @{
 */

  /*!
   * \brief
   * A PainterShaderGroup gives to what groups the active shaders
   * of a \ref Painter belong.
   */
  class PainterShaderGroup:noncopyable
  {
  public:
    /*!
     * The group (see PainterShader::group())
     * of the active blend shader.
     */
    uint32_t
    blend_group(void) const;

    /*!
     * The group (see PainterShader::group())
     * of the active item shader.
     */
    uint32_t
    item_group(void) const;

    /*!
     * The group (see PainterShader::group())
     * of the active brush shader.
     */
    uint32_t
    brush_group(void) const;

    /*!
     * The \ref BlendMode value for the active blend shader.
     */
    BlendMode
    blend_mode(void) const;

    /*!
     * Returns the \ref PainterBlendShader::shader_type
     * of the active \ref PainterBlendShader. If there is
     * no active \ref PainterBlendShader, returns \ref
     * PainterBlendShader::number_types .
     */
    enum PainterBlendShader::shader_type
    blend_shader_type(void) const;

  protected:
    /*!
     * Ctor, do NOT derive from PainterShaderGroup, doing
     * so is asking for heaps of trouble and pain.
     */
    PainterShaderGroup(void) {}
  };

/*! @} */
}

#endif