EPOK RUNTIME
epok::SubViewport2DComponent
Class
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.
Class
---- SubViewport2D -------------------------------------------------------------------------
Basic usage
This generated sketch illustrates syntax for reaching the type; adapt it to the actual API contract. Open a member below for an operation-specific example.
C++ example
#include "world2d_viewports.hpp"
epok::SubViewport2DComponent& value = /* obtain a valid instance from your game */;Fields and constants
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.FieldcountdownRuntime.FieldenabledExposes `enabled` on `epok::SubViewport2DComponent` for the world2d viewports module.FieldheightExposes `height` on `epok::SubViewport2DComponent` 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::SubViewport2DComponent` for the world2d viewports module.Fieldnative_indexExposes `native_index` on `epok::SubViewport2DComponent` for the world2d viewports module.Fieldstatic_class_idExposes `static_class_id` on `epok::SubViewport2DComponent` 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).FieldwidthExposes `width` on `epok::SubViewport2DComponent` for the world2d viewports module.FieldPublic methods
~SubViewport2DComponentReleases the resources owned by `epok::SubViewport2DComponent`.destructorclass_idPerforms `class id` as part of the world2d viewports module.Methodget_cameraReturns camera as part of the world2d viewports module.Methodis_enabledReports whether enabled 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_intervalRedraw every `frames` frames (1: every frame); a still picture costs nothing between.MethodviewThe view this picture is drawn through: the camera's, recentred on the picture.Method