source/src/engine/gl/pipeline-rasterization-state.hpp

/*
 * Copyright (C) 2023  Christopher J. Howard
 *
 * This file is part of Antkeeper source code.
 *
 * Antkeeper source code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Antkeeper source code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Antkeeper source code.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ANTKEEPER_GL_PIPELINE_RASTERIZATION_STATE_HPP
#define ANTKEEPER_GL_PIPELINE_RASTERIZATION_STATE_HPP

#include <engine/gl/front-face.hpp>
#include <engine/gl/cull-mode.hpp>
#include <engine/gl/fill-mode.hpp>
#include <engine/gl/provoking-vertex-mode.hpp>
#include <cstdlib>

namespace gl {

/// Pipeline rasterization state.
struct pipeline_rasterization_state
{
	/// `true` if rasterizer discard should be enabled, `false` otherwise.
	bool rasterizer_discard_enabled{false};
	
	/// Polygon rasterization mode.
	gl::fill_mode fill_mode{gl::fill_mode::fill};
	
	/// Triangle culling mode.
	gl::cull_mode cull_mode{gl::cull_mode::back};
	
	/// Polygon front-facing orientation.
	gl::front_face front_face{gl::front_face::counter_clockwise};
	
	/// `true` if depth bias should be enabled, `false` otherwise.
	bool depth_bias_enabled{false};
	
	/// Depth bias constant factor.
	float depth_bias_constant_factor{0.0f};
	
	/// Depth bias slope factor.
	float depth_bias_slope_factor{0.0f};
	
	/// `true` if depth clamp should be enabled, `false` otherwise.
	bool depth_clamp_enabled{false};
	
	/// `true` if scissor testing should be enabled, `false` otherwise.
	bool scissor_test_enabled{false};
	
	/// Vertex to be used as the source of data for flat-shaded varyings.
	gl::provoking_vertex_mode provoking_vertex_mode{gl::provoking_vertex_mode::last};
	
	/// Diameter of rasterized points.
	float point_size{1.0f};
	
	/// Width of rasterized line segments.
	float line_width{1.0f};
};

} // namespace gl

#endif // ANTKEEPER_GL_PIPELINE_RASTERIZATION_STATE_HPP