RenderMode.hpp

Go to the documentation of this file.

/*
 * Author: Sven Gothel <sgothel@jausoft.com> (C++, Java) and Rami Santina (Java)
 * Copyright Gothel Software e.K. and the authors
 *
 * SPDX-License-Identifier: MIT
 *
 * This Source Code Form is subject to the terms of the MIT License
 * If a copy of the MIT was not distributed with this file,
 * you can obtain one at https://opensource.org/license/mit/.
 */
#ifndef JAU_GAMP_GRAPH_RENDERMODE_HPP_
#define JAU_GAMP_GRAPH_RENDERMODE_HPP_
 
#include <cstdint>
 
#include <jau/enum_util.hpp>
 
namespace gamp::graph {
 
    using namespace jau::enums;
    
    /** \addtogroup Gamp_Graph
     *
     *  @{
     */
 
    /** 
     * Render mode bits being part of the shader-selection-key.
     * @see renderMode() 
     */
    enum class RenderMode : uint16_t {        
        /**
         * One pass `none` rendering either using no AA or underlying full-screen AA (fsaa) nor extra channels nor data.
         */
        none = 0,
    
        /**
         * MSAA based Anti-Aliasing, a two pass region rendering, slower and more
         * resource hungry (FBO with sample buffer), but providing fast MSAA in case
         * the whole scene is not rendered with MSAA.
         *
         * In case sample count is 1, no FBO sample buffer is used but a simple bilinear texture filter.
         */
        msaa  = 1 <<  0,
    
        /**
         * View based Anti-Aliasing, a two pass region rendering, slower and more
         * resource hungry (FBO), but AA is perfect. Otherwise the default fast one
         * pass MSAA region rendering is being used.
         *
         * In case sample count is 1, no FBO supersampling is performed but a simple bilinear texture filter used.
         *
         * Depending on AA-quality, {@link #MAX_AA_QUALITY} denotes full 4x billinear filtering per sample
         * and {@code 0} denotes 1x flipquad filtering per sample.
         */
        vbaa  = 1 <<  1,
        
        /** 2-pass rendering bit-mask including RenderBits::msaa and RenderBits::vbaa. */
        aa_mask   = msaa | vbaa,
    
        /**
         * Use non uniform weights [0.0 .. 1.9] for curve region rendering.
         * Otherwise the default weight 1.0 for uniform curve region rendering is
         * being applied.
         */
        varweight = 1 <<  8,
    
        /**
         * If set, a full normal channel attribute per vertex is added to the stream.
         */
        normalchannel = 1 <<  9,
        
        /**
         * If set, a color channel attribute per vertex is added to the stream,
         * otherwise static color can being used for a monotonic color.
         */
        colorchannel = 1 <<  10,
    
        /**
         * If set, a color texture is used to determine the color via TextureSequence passed to the implementation.
         * @see TextureSequence#useARatioAdjustment()
         * @see TextureSequence#useARatioLetterbox()
         */
        colortexture = 1 <<  11,
        
        /// Enable light0, implies normalchannel
        light0 = 1 <<  12
    };    
    JAU_MAKE_BITFIELD_ENUM_STRING(RenderMode, msaa, vbaa, varweight, normalchannel, colorchannel, colortexture, light0);
 
    /** Returns true if given {@code renderModes} has RenderMode::vbaa set. */
    constexpr inline bool isVBAA(RenderMode renderMode) noexcept { return is_set(renderMode, RenderMode::vbaa); }
 
    /** Returns true if given {@code renderModes} has RenderMode::msaa set. */
    constexpr inline bool isMSAA(RenderMode renderMode) noexcept { return is_set(renderMode, RenderMode::msaa); }
 
    /** Returns true if given {@code renderModes} has any of RenderMode::aa_mask set. */
    constexpr inline bool isGraphAA(RenderMode renderMode) noexcept { return has_any(renderMode, RenderMode::aa_mask); }
 
    /** Returns true if given {@code renderModes} has any of RenderMode::aa_mask set. */
    constexpr inline bool isTwoPass(RenderMode renderMode) noexcept { return isGraphAA(renderMode); }
 
    constexpr inline bool hasVariableWeight(RenderMode renderMode) noexcept { return is_set(renderMode, RenderMode::varweight); }
 
    constexpr inline bool hasNormalChannel(RenderMode m) noexcept { return is_set(m, RenderMode::light0) || is_set(m, RenderMode::normalchannel); }
    constexpr inline bool hasColorChannel(RenderMode m) noexcept { return is_set(m, RenderMode::colorchannel); }
    
    /**
     * Returns true if render mode has a color texture,
     * i.e. the bit {@link #COLORTEXTURE_RENDERING_BIT} is set,
     * otherwise false.
     */
    constexpr inline bool hasColorTexture(RenderMode renderMode) noexcept { return is_set(renderMode, RenderMode::colortexture); }
 
    constexpr inline bool hasLight0(RenderMode m) noexcept { return is_set(m, RenderMode::light0); }
    
    /**@}*/
 
} // namespace gamp::graph
 
#endif // JAU_GAMP_GRAPH_RENDERMODE_HPP_