class

AViewport

Module
Arc
Header
#include "Arc/Framework/AViewport.h"
Namespace
Arcf

Public functions

ReturnsNameDescription
ARC_WIDGET_ARGS
ArcVec2ComputeDesiredSize
boolCanCacheDesiredSizeA constant minimum.
boolDesiredSizeDependsOnChildren
boolCanRetainPaintRefused: the surface behind it is re-rendered every frame, and the client draws over it from state no widget setter covers.
int32_tOnPaint
CReplyOnMouseButtonDown
CReplyOnMouseButtonUp
CReplyOnMouseMove
CReplyOnMouseWheel
CReplyOnKeyDown
CReplyOnKeyUp
voidSetViewportClient
voidSetRenderTarget
voidSetRenderTargetUVMaxTop-left fraction of the target that holds valid content — the active subrect when the source is a dynamic-resolution chain allocated larger than the frame rendered.
voidSetLateRenderTargetA target the render thread swaps after this widget painted (see CArcLateTexture); it wins over SetRenderTarget while set.
const char*GetTypeName
uint64_tGetPaintCountHow many times the viewport has been painted.

Function details

ARC_WIDGET_ARGS

C++
ARC_WIDGET_ARGS(AViewport) ARC_ARG(IArcViewportClient*, ViewportClient) ARC_ARG(IArcRHITexture*, RenderTarget) ARC_WIDGET_ARGS_END() void Construct(const CArguments& args)

ComputeDesiredSize

C++
ArcVec2 ComputeDesiredSize(float scale) const override

CanCacheDesiredSize

C++
bool CanCacheDesiredSize() const override

A constant minimum. The render target behind it changes every frame and never reaches layout — the viewport takes the space its slot gives it.

DesiredSizeDependsOnChildren

C++
bool DesiredSizeDependsOnChildren() const override

CanRetainPaint

C++
bool CanRetainPaint() const override

Refused: the surface behind it is re-rendered every frame, and the client draws over it from state no widget setter covers.

OnPaint

C++
int32_t OnPaint(const CArcPaintArgs& args, const CGeometry& geo, CArcUIRenderer& renderer, int32_t layerId) const override

OnMouseButtonDown

C++
CReply OnMouseButtonDown(const CGeometry& geo, const CPointerEvent& event) override

OnMouseButtonUp

C++
CReply OnMouseButtonUp(const CGeometry& geo, const CPointerEvent& event) override

OnMouseMove

C++
CReply OnMouseMove(const CGeometry& geo, const CPointerEvent& event) override

OnMouseWheel

C++
CReply OnMouseWheel(const CGeometry& geo, const CPointerEvent& event) override

OnKeyDown

C++
CReply OnKeyDown(const CGeometry& geo, const CKeyEvent& event) override

OnKeyUp

C++
CReply OnKeyUp(const CGeometry& geo, const CKeyEvent& event) override

SetViewportClient

C++
void SetViewportClient(IArcViewportClient* client)

SetRenderTarget

C++
void SetRenderTarget(IArcRHITexture* target)

SetRenderTargetUVMax

C++
void SetRenderTargetUVMax(const ArcVec2& uvMax)

Top-left fraction of the target that holds valid content — the active subrect when the source is a dynamic-resolution chain allocated larger than the frame rendered. (1,1) samples it all.

SetLateRenderTarget

C++
void SetLateRenderTarget(const std::shared_ptr<CArcLateTexture>& late)

A target the render thread swaps after this widget painted (see CArcLateTexture); it wins over SetRenderTarget while set.

GetTypeName

C++
const char* GetTypeName() const override

GetPaintCount

C++
uint64_t GetPaintCount() const

How many times the viewport has been painted. A host stops rendering into a viewport whose count stops moving: its tab is behind another, or its window is gone, and nothing shows the image.

Generated from Arc/Framework/AViewport.h via arc.json · Nov 5, 2026Version 1.0.0