User Tools

Site Tools


orxVIEWPORT structure

Viewport module. Allows the creation and handling of viewports. Viewports are structures associated to cameras and used for rendering.


BackgroundColor  = <vector>
BackgroundAlpha  = <float>
Camera           = CameraTemplate;
Position         =  left | right | top | bottom
Position         = <vector>
Size             = <vector>
UseRelativeSize  = <bool>
ShaderList       = ShaderTemplate1#ShaderTemplate2
TextureList      = path/to/TextureFile # ... #path/to/TextureFileN


Here's a list of the available properties for an orxVIEWPORT structure:

  • BackgroundColor: Defines which color will be used for clearing the viewport before rendering it. If not set, the viewport won't erase any part of other viewports previously rendered this frame if there are overlaps.
  • BackgroundAlpha: If BackgroundColor is set, this value will be used as alpha; Defaults to 1.0;
  • Camera: Template name of the camera that will be linked to this viewport. Each camera template will correspond to a unique camera at runtime. This means that if you use more than one viewport linked to the same camera, they will render the same content as seen by this camera.
  • Position: Defines where the viewport will be placed in the main display. It should be a combination of two attributes. Ex.: top left to have your viewport in the top left corner. Its default value is top left.
  • Position: Defines an absolute position for the viewport in the main display, in pixel coordinates. This value is only used if none is provided for RelativePosition.
  • UseRelativeSize: If true, the viewport size will be interpreted as relative to the underlying texture, using the [0.0 - 1.0] range on both x/y axes. Defaults to false.
  • Size: Defines the absolute viewport size, in pixels. This value is only used if none is provided for RelativeSize.
  • TextureList: Defines a destination texture or list of textures where the viewport will be rendered. Its default value is the main display (ie. screen).
  • ShaderList: Defines a list of shaders that will be executed every time this viewport is rendered. Up to 4 shaders can be specified. By default, no shader is used.

Latest config settings for the Development Version

We endeavor to keep the config properties on this page up to date as often as possible. For up to the minute config information for the latest version of Orx, check the most recent published at:

CreationTemplate.ini and


Additionally these files can be found under your orx source tree in the orx/code/bin folder.

en/orx/config/settings_structure/orxviewport.txt · Last modified: 2021/02/11 21:33 (2 years ago) by sausage