buffer_control.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Harry Storbacka
*/


#pragma once

#include "../api_display.h"
#include "../../Core/System/sharedptr.h"
#include "compare_function.h"

enum CL_StencilOp
{
        cl_stencil_keep,
        cl_stencil_zero,
        cl_stencil_replace,
        cl_stencil_incr,
        cl_stencil_decr,
        cl_stencil_invert,
        cl_stencil_incr_wrap,
        cl_stencil_decr_wrap
};

enum CL_DrawBuffer
{
        cl_buffer_none,
        cl_buffer_front_left,
        cl_buffer_front_right,
        cl_buffer_back_left,
        cl_buffer_back_right,
        cl_buffer_front,
        cl_buffer_back,
        cl_buffer_left,
        cl_buffer_right,
        cl_buffer_front_and_back,
        cl_buffer_aux0,
        cl_buffer_aux1,
        cl_buffer_aux2,
        cl_buffer_aux3
};

enum CL_LogicOp
{
        cl_logic_op_clear,
        cl_logic_op_and, 
        cl_logic_op_and_reverse,
        cl_logic_op_copy,
        cl_logic_op_and_inverted,
        cl_logic_op_noop,
        cl_logic_op_xor,
        cl_logic_op_or,
        cl_logic_op_nor,
        cl_logic_op_equiv,
        cl_logic_op_invert,
        cl_logic_op_or_reverse,
        cl_logic_op_copy_inverted,
        cl_logic_op_or_inverted,
        cl_logic_op_nand,
        cl_logic_op_set
};

class CL_BufferControl_Impl;

class CL_API_DISPLAY CL_BufferControl
{

public:
        CL_BufferControl();

        virtual ~CL_BufferControl();


public:
        bool is_stencil_test_enabled() const;

        CL_CompareFunction get_stencil_compare_func_front() const;

        CL_CompareFunction get_stencil_compare_func_back() const;

        int get_stencil_compare_reference_front() const;

        int get_stencil_compare_reference_back() const;

        CL_StencilOp get_stencil_fail_front() const;

        CL_StencilOp get_stencil_fail_back() const;

        CL_StencilOp get_stencil_pass_depth_pass_front() const;

        CL_StencilOp get_stencil_pass_depth_pass_back() const;

        CL_StencilOp get_stencil_pass_depth_fail_front() const;

        CL_StencilOp get_stencil_pass_depth_fail_back() const;

        unsigned char get_stencil_compare_mask_front() const;

        unsigned char get_stencil_compare_mask_back() const;

        unsigned char get_stencil_write_mask_front() const;

        unsigned char get_stencil_write_mask_back() const;

        bool is_depth_test_enabled() const;

        bool is_depth_write_enabled() const;

        CL_CompareFunction get_depth_compare_function() const;

        void is_color_write_enabled(bool &red, bool &green, bool &blue, bool &alpha) const;

        CL_DrawBuffer get_draw_buffer() const;

        bool is_logic_op_enabled() const;

        CL_LogicOp get_logic_op() const;


public:
        void enable_stencil_test(bool enabled);

        void set_stencil_compare_func(CL_CompareFunction front, CL_CompareFunction back);

        void set_stencil_compare_reference(int front_ref, int back_ref);

        void set_stencil_write_mask(unsigned char front_facing_mask, unsigned char back_facing_mask);

        void set_stencil_fail(CL_StencilOp front, CL_StencilOp back);

        void set_stencil_pass_depth_pass(CL_StencilOp front, CL_StencilOp back);

        void set_stencil_pass_depth_fail(CL_StencilOp front, CL_StencilOp back);

        void set_stencil_compare_mask(int front_mask, int back_mask);

        void enable_depth_test(bool enabled);

        void enable_depth_write(bool enabled);

        void set_depth_compare_function(CL_CompareFunction func);

        void enable_color_write(bool enabled);

        void enable_color_write(bool red, bool green, bool blue, bool alpha);

        void set_draw_buffer(CL_DrawBuffer buffer);

        void enable_logic_op(bool enabled);

        void set_logic_op(CL_LogicOp op);


private:
        CL_SharedPtr<CL_BufferControl_Impl> impl;
};

---