/*
|
|
* 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_RENDER_STAGE_HPP
|
|
#define ANTKEEPER_RENDER_STAGE_HPP
|
|
|
|
#include "render/context.hpp"
|
|
|
|
namespace render {
|
|
|
|
/**
|
|
* Abstract base class for a single stage in a render pipeline.
|
|
*/
|
|
class stage
|
|
{
|
|
public:
|
|
/**
|
|
* Constructs a render stage and sets it priority.
|
|
*
|
|
* @param priority Stage execution order priority.
|
|
*/
|
|
stage(int priority);
|
|
|
|
/// Constructs a render stage.
|
|
stage();
|
|
|
|
/// Destructs a render stage.
|
|
virtual ~stage() = default;
|
|
|
|
/**
|
|
* Executes the render stage.
|
|
*
|
|
* @param ctx Render context.
|
|
*/
|
|
virtual void execute(render::context& ctx) const = 0;
|
|
|
|
/**
|
|
* Sets the priority of the stage's execution order in the render pipeline.
|
|
*
|
|
* @param priority Stage execution order priority. Stages with lower priorities are executed first.
|
|
*/
|
|
void set_priority(int priority);
|
|
|
|
/// Returns the priority of the stage's execution order in the render pipeline.
|
|
int get_priority() const noexcept;
|
|
|
|
private:
|
|
int priority;
|
|
};
|
|
|
|
inline int stage::get_priority() const noexcept
|
|
{
|
|
return priority;
|
|
}
|
|
|
|
} // namespace render
|
|
|
|
#endif // ANTKEEPER_RENDER_STAGE_HPP
|