Jazz2::Rendering::UpscaleRenderPassWithClipping class
#include <Jazz2/Rendering/UpscaleRenderPass.h>

Upscales input image usually to a native resolution, additionaly supports 3 independent layers (background layer, clipped main layer, overlay layer).

Variant of UpscaleRenderPass that upscales three separate scene nodes (background, scissor-clipped main layer, and overlay) so the main layer can be clipped to a rectangle independently of the surrounding content.

Base classes

class UpscaleRenderPass: Upscales input image usually to a native resolution.

Constructors, destructors, conversion operators

UpscaleRenderPassWithClipping(): Creates a new instance.

Public functions

void Initialize(std::int32_t width, std::int32_t height, std::int32_t targetWidth, std::int32_t targetHeight) override: Initializes the render pass.
void Register() override: Registers the render pass into the viewport chain.
auto GetClippedNode() const -> SceneNode*: Returns the clipped main layer node.
auto GetOverlayNode() const -> SceneNode*: Returns the overlay layer node.
void SetClipRectangle(const Recti& scissorRect): Sets the clipping rectangle of the main layer.

Function documentation

void Jazz2::Rendering::UpscaleRenderPassWithClipping::Initialize(std::int32_t width, std::int32_t height, std::int32_t targetWidth, std::int32_t targetHeight) override

Initializes the render pass.