Jazz2::Rendering::UpscaleRenderPass class

Upscales input image usually to a native resolution.

Final output pass that renders the low-resolution scene through a rescale shader to the native output resolution, optionally routing it through an AntialiasingSubpass. Exposes the input scene node that the rest of the rendering attaches to.

Base classes

class nCine::SceneNode
Base node of the scene graph transformation hierarchy.

Derived classes

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

Constructors, destructors, conversion operators

UpscaleRenderPass()
Creates a new instance.

Public functions

void Initialize(std::int32_t width, std::int32_t height, std::int32_t targetWidth, std::int32_t targetHeight) virtual
Initializes the render pass.
void Register() virtual
Registers the render pass into the viewport chain.
auto OnDraw(RenderQueue& renderQueue) -> bool override
Called when the node needs to be drawn, returning true if a command was added.
auto GetNode() const -> SceneNode*
Returns the input scene node.
auto GetViewSize() const -> Vector2i
Returns size of the input image.
auto GetTargetSize() const -> Vector2f
Returns size of the upscaled target image.

Protected types

class AntialiasingSubpass
Optional antialiasing subpass.

Function documentation

void Jazz2::Rendering::UpscaleRenderPass::Initialize(std::int32_t width, std::int32_t height, std::int32_t targetWidth, std::int32_t targetHeight) virtual

Initializes the render pass.

Parameters
width Width of the input image
height Height of the input image
targetWidth Width of the upscaled target image
targetHeight Height of the upscaled target image