oa::Viewport

— Passive view description for rendering Declares: camera, target, viewport, and view-specific settings. Does NOT: handle input, own windows, manage swapchains, or animate.

ClC++ public headers

Public Methods

void oa::Viewport::disableScissor()

const oa::Camera * oa::Viewport::getCamera()

const oa::vlm::Vec4 & oa::Viewport::getClearColor()

oa::F32 oa::Viewport::getClearDepth()

RenderLayer oa::Viewport::getLayerMask()

ViewportMode oa::Viewport::getMode()

const ScissorDesc & oa::Viewport::getScissor()

const oa::Texture * oa::Viewport::getTarget()

const ViewportDesc & oa::Viewport::getViewport()

bool oa::Viewport::isLayerVisible(RenderLayer inLayer)

bool oa::Viewport::isScissorEnabled()

bool oa::Viewport::isValid()

void oa::Viewport::setCamera(const oa::Camera * inCamera)

oa::Status oa::Viewport::setClearColor(const oa::vlm::Vec4 & inColor)

oa::Status oa::Viewport::setClearDepth(oa::F32 inDepth)

void oa::Viewport::setLayerMask(RenderLayer inMask)

oa::Status oa::Viewport::setMode(ViewportMode inMode)

oa::Status oa::Viewport::setScissor(const ScissorDesc & inScissor)

void oa::Viewport::setTarget(const oa::Texture * inTarget)

oa::Status oa::Viewport::setupImage2D(oa::F32 inImageWidth, oa::F32 inImageHeight, const oa::Texture * inTarget, const ViewportDesc & inViewport)

oa::Status oa::Viewport::setupImageAspectFit(oa::F32 inImageWidth, oa::F32 inImageHeight, oa::F32 inWindowWidth, oa::F32 inWindowHeight, const oa::Texture * inTarget)

oa::Status oa::Viewport::setViewport(const ViewportDesc & inViewport)

Constructor & Destructor Documentation

oa::Viewport::Viewport()

No public source comment is attached to this declaration.

oa::Viewport::Viewport(
	ViewportMode inMode
)

No public source comment is attached to this declaration.

Parameters

inMode

ViewportMode

—

Public Method Documentation

void oa::Viewport::disableScissor()

No public source comment is attached to this declaration.

Returns

void

The declared return value.

const oa::Camera * oa::Viewport::getCamera()

No public source comment is attached to this declaration.

Returns

const oa::Camera *

The declared return value.

const oa::vlm::Vec4 & oa::Viewport::getClearColor()

No public source comment is attached to this declaration.

Returns

const oa::vlm::Vec4 &

The declared return value.

oa::F32 oa::Viewport::getClearDepth()

No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

RenderLayer oa::Viewport::getLayerMask()

No public source comment is attached to this declaration.

Returns

RenderLayer

The declared return value.

ViewportMode oa::Viewport::getMode()

No public source comment is attached to this declaration.

Returns

ViewportMode

The declared return value.

const ScissorDesc & oa::Viewport::getScissor()

No public source comment is attached to this declaration.

Returns

const ScissorDesc &

The declared return value.

const oa::Texture * oa::Viewport::getTarget()

No public source comment is attached to this declaration.

Returns

const oa::Texture *

The declared return value.

const ViewportDesc & oa::Viewport::getViewport()

No public source comment is attached to this declaration.

Returns

const ViewportDesc &

The declared return value.

bool oa::Viewport::isLayerVisible(
	RenderLayer inLayer
)

Check if a layer is visible

Parameters

inLayer

RenderLayer

—

Returns

bool

The declared return value.

bool oa::Viewport::isScissorEnabled()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::Viewport::isValid()

Validation.

Returns

bool

The declared return value.

void oa::Viewport::setCamera(
	const oa::Camera * inCamera
)

camera (required).

Parameters

inCamera

const oa::Camera *

—

Returns

void

The declared return value.

oa::Status oa::Viewport::setClearColor(
	const oa::vlm::Vec4 & inColor
)

═══════════════════════════════════════════════════════════════════════ clear values ═══════════════════════════════════════════════════════════════════════

Parameters

inColor

const oa::vlm::Vec4 &

—

Returns

oa::Status

The declared return value.

oa::Status oa::Viewport::setClearDepth(
	oa::F32 inDepth
)

No public source comment is attached to this declaration.

Parameters

inDepth

oa::F32

—

Returns

oa::Status

The declared return value.

void oa::Viewport::setLayerMask(
	RenderLayer inMask
)

═══════════════════════════════════════════════════════════════════════ layer filtering ═══════════════════════════════════════════════════════════════════════

Parameters

inMask

RenderLayer

—

Returns

void

The declared return value.

oa::Status oa::Viewport::setMode(
	ViewportMode inMode
)

Mode and configuration.

Parameters

inMode

ViewportMode

—

Returns

oa::Status

The declared return value.

oa::Status oa::Viewport::setScissor(
	const ScissorDesc & inScissor
)

No public source comment is attached to this declaration.

Parameters

inScissor

const ScissorDesc &

—

Returns

oa::Status

The declared return value.

void oa::Viewport::setTarget(
	const oa::Texture * inTarget
)

═══════════════════════════════════════════════════════════════════════ Render target (required) ═══════════════════════════════════════════════════════════════════════

Parameters

inTarget

const oa::Texture *

—

Returns

void

The declared return value.

oa::Status oa::Viewport::setupImage2D(
	oa::F32 inImageWidth,
	oa::F32 inImageHeight,
	const oa::Texture * inTarget,
	const ViewportDesc & inViewport
)

Setup for 2D image viewing (orthographic camera)

Parameters

inImageWidth

oa::F32

—

inImageHeight

oa::F32

—

inTarget

const oa::Texture *

—

inViewport

const ViewportDesc &

—

Returns

oa::Status

The declared return value.

oa::Status oa::Viewport::setupImageAspectFit(
	oa::F32 inImageWidth,
	oa::F32 inImageHeight,
	oa::F32 inWindowWidth,
	oa::F32 inWindowHeight,
	const oa::Texture * inTarget
)

Setup for aspect-fit image display

Parameters

inImageWidth

oa::F32

—

inImageHeight

oa::F32

—

inWindowWidth

oa::F32

—

inWindowHeight

oa::F32

—

inTarget

const oa::Texture *

—

Returns

oa::Status

The declared return value.

oa::Status oa::Viewport::setViewport(
	const ViewportDesc & inViewport
)

═══════════════════════════════════════════════════════════════════════ viewport and scissor ═══════════════════════════════════════════════════════════════════════

Parameters

inViewport

const ViewportDesc &

—

Returns

oa::Status

The declared return value.