Epok Engine

EPOK RUNTIME

World2D Viewports

world2d_viewports.hpp · the world2d viewports module

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Module

the world2d viewports module.

Header
world2d_viewports.hpp
Include
#include "world2d_viewports.hpp"
Stability
Epok runtime API

Include this module

C++ include
#include "world2d_viewports.hpp"

Types

Functions and methods

~SplitScreen2DComponentReleases the resources owned by `epok::SplitScreen2DComponent`.destructor~SubViewport2DComponentReleases the resources owned by `epok::SubViewport2DComponent`.destructoracceptsPerforms `accepts` as part of the world2d viewports module.Methodactive_splitThe active split screen, when both its cameras exist.Functioncamera_onPerforms `camera on` as part of the world2d viewports module.Functionclass_idPerforms `class id` as part of the world2d viewports module.Methodclass_idPerforms `class id` as part of the world2d viewports module.Methodget_cameraReturns camera as part of the world2d viewports module.MethodhalfScreen rectangle (x, y, w, h) of half `index`, either side of the divider.MethodhidePerforms `hide` as part of the world2d viewports module.Methodis_enabledReports whether enabled as part of the world2d viewports module.Methodis_enabledReports whether enabled as part of the world2d viewports module.Methodis_side_by_sideReports whether side by side as part of the world2d viewports module.Methodlevel_attachedPerforms `level attached` as part of the world2d viewports module.Methodlevel_attachedPerforms `level attached` as part of the world2d viewports module.Methodset_cameraSets camera as part of the world2d viewports module.Methodset_enabledSets enabled as part of the world2d viewports module.Methodset_enabledSets enabled as part of the world2d viewports module.Methodset_intervalRedraw every `frames` frames (1: every frame); a still picture costs nothing between.Methodset_side_by_sideSets side by side as part of the world2d viewports module.Methodsubviewport_onPerforms `subviewport on` as part of the world2d viewports module.FunctionviewThe view through camera `index`, its projection centred on its half.MethodviewThe view this picture is drawn through: the camera's, recentred on the picture.Method

Fields, variables and values

backgroundExposes `background` on `epok::SubViewport2DComponent` for the world2d viewports module.FieldcameraAuthored: the camera (an actor with a Camera2D; none: the active camera), the picture's size and background, how often it redraws, and its canvas filter.Fieldcameranull: the active cameraFieldcamerasExposes `cameras` on `epok::SplitScreen2DComponent` for the world2d viewports module.FieldclipExposes `clip` on `epok::world2d::RenderPass` for the world2d viewports module.FieldcountdownRuntime.FielddepthDepth2D drawables leave their canvas for the 3D ordering table: only the screen view of a frame with a 3D camera and no split screen sets this.FieldDepth3DNamed value `Depth3D` in `epok::world2d::DrawPhase`.Enum valuedividerExposes `divider` on `epok::SplitScreen2DComponent` for the world2d viewports module.Fielddivider_colorExposes `divider_color` on `epok::SplitScreen2DComponent` for the world2d viewports module.FieldenabledExposes `enabled` on `epok::SplitScreen2DComponent` for the world2d viewports module.FieldenabledExposes `enabled` on `epok::SubViewport2DComponent` for the world2d viewports module.Fieldevery_layerExposes `every_layer` on the `epok::world2d` namespace for the world2d viewports module.VariableheightExposes `height` on `epok::SubViewport2DComponent` for the world2d viewports module.FieldhiddenExposes `hidden` on `epok::world2d::RenderPass` for the world2d viewports module.Fieldhidden_countExposes `hidden_count` on `epok::world2d::RenderPass` for the world2d viewports module.Fieldhide_layerExposes `hide_layer` on `epok::SubViewport2DComponent` for the world2d viewports module.FieldintervalExposes `interval` on `epok::SubViewport2DComponent` for the world2d viewports module.FieldlayerExposes `layer` on `epok::SubViewport2DComponent` for the world2d viewports module.Fieldlink2dExposes `link2d` on `epok::SplitScreen2DComponent` for the world2d viewports module.Fieldlink2dExposes `link2d` on `epok::SubViewport2DComponent` for the world2d viewports module.Fieldnative_indexExposes `native_index` on `epok::SubViewport2DComponent` for the world2d viewports module.Fieldonly_layerExposes `only_layer` on `epok::world2d::RenderPass` for the world2d viewports module.FieldOver3DNamed value `Over3D` in `epok::world2d::DrawPhase`.Enum valuerender_passExposes `render_pass` on the `epok::world2d` namespace for the world2d viewports module.Variablescreenworld canvases, screen canvasesFieldside_by_sideExposes `side_by_side` on `epok::SplitScreen2DComponent` for the world2d viewports module.Fieldsplit_screensExposes `split_screens` on the `epok::world2d` namespace for the world2d viewports module.Variablestatic_class_idExposes `static_class_id` on `epok::SplitScreen2DComponent` for the world2d viewports module.Variablestatic_class_idExposes `static_class_id` on `epok::SubViewport2DComponent` for the world2d viewports module.VariablesubviewportsExposes `subviewports` on the `epok::world2d` namespace for the world2d viewports module.Variabletarget_xCooked VRAM placement of the picture (a 64-halfword-aligned column, inside one 256-line page row).Fieldtarget_yCooked VRAM placement of the picture (a 64-halfword-aligned column, inside one 256-line page row).FieldUnder3DNamed value `Under3D` in `epok::world2d::DrawPhase`.Enum valuewidthExposes `width` on `epok::SubViewport2DComponent` for the world2d viewports module.Fieldworldworld canvases, screen canvasesField