User Tools

Site Tools


en:orx:config:settings_structure:orxviewport

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
en:orx:config:settings_structure:orxviewport [2023/05/23 05:49 (10 months ago)] – Updated with new properties sausageen:orx:config:settings_structure:orxviewport [2023/09/19 23:42 (6 months ago)] (current) sausage
Line 6: Line 6:
 ==== Summary ==== ==== Summary ====
  
-<code ini>[ViewportTemplate] +<code ini> 
-AutoResize  = <bool> +[ViewportTemplate] 
-BackgroundColor  = <vector> | <WebColor+TextureList     = Texture1 # ... # TextureN 
-BackgroundAlpha  = <float+KeepInCache     = <bool> 
-BlendMode = alpha|multiply|add|premul|none +Position        (center) (left | right) (top | bottom) | <vector> 
-Camera           = CameraTemplate +Size            = <vector
-FixedRatio  = <float+UseRelativeSize = <bool
-KeepInCache  = <bool+BackgroundColor = <vector
-NoDebug  = <bool+BackgroundAlpha = <float
-Position         center left|right top|bottom +Camera          CameraTemplate 
-Position         = <vector> +FixedRatio      = <float
-Size             = <vector+ShaderList      = ShaderTemplate1 # ... # ShaderTemplateN 
-ShaderList       = ShaderTemplate1 # ... # ShaderTemplateN +BlendMode       = alpha | multiply | add | premul | none 
-TextureList      path/to/TextureFile # ... #path/to/TextureFileN +AutoResize      <bool> 
-UseRelativeSize  = <bool>+NoDebug         = <bool>
 </code> </code>
  
Line 27: Line 27:
  
 Here's a list of the available properties for an ''orxVIEWPORT'' structure: Here's a list of the available properties for an ''orxVIEWPORT'' structure:
-  * ''AutoResize'': [Bool]; NBDefault value is true if no fixed size is given, false otherwiseIt's only applicable to viewports with linked textures. If true, viewport's dimension, position and linked textures will be resized/updated upon video mode changes.+  * ''TextureList'': Textures used as destination when rendering that viewport. If the specified name doesn't refer to an existing texture, a texture of that name will be automatically created, matching the viewport's dimensions. Defaults to screen when not defined. 
 +  * ''KeepInCache''If true, the associated textures will always stay in cache. Defaults to false. 
 +  * ''Position'': Literal position (example: top left) or position in pixels, from the top left corner. Defaults to top left. 
 +  * ''Size'': Size in pixels. 
 +  * ''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.
   * ''BackgroundColor'': Values are RGB from 0 to 255. Official HTML web color names are also supported. If not set, the viewport won't erase any part of other overlapping viewports that were previously rendered this frame.   * ''BackgroundColor'': Values are RGB from 0 to 255. Official HTML web color names are also supported. If not set, the viewport won't erase any part of other overlapping viewports that were previously rendered this frame.
-  * ''BackgroundAlpha'': If BackgroundColor is set, this value will be used as alphaDefaults to 1.0;+  * ''BackgroundAlpha'': If BackgroundColor is set, this value will be used as alphaDefaults to 1.0
 +  * ''FixedRatio'': Only used when no camera is linked, otherwise the aspect ratio of the camera will act as ratio for the viewport. Defaults to none, ie. no fixed ratio is enforced. 
 +  * ''ShaderList'': Defines a list of shaders that will be executed every time this viewport is rendered. Shader will be activated immediately. Up to 4 shaders can be defined. By default, no shader is used.
   * ''BlendMode'': Default value is none, used only when active shaders are attached.   * ''BlendMode'': Default value is none, used only when active shaders are attached.
-  * ''Camera'': Template name of the camera that will be linked to this viewport. Each [[orxCAMERA|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. +  * ''AutoResize'': Default value is true if no fixed size is givenfalse otherwise. It's only applicable to viewports with linked textures. If true, viewport's dimension, position and linked textures will be resized/updated upon video mode changes.
-  * ''FixedRatio'' = [Float]; NB: Only used when no camera is linked, otherwise the aspect ratio of the camera will act as ratio for the viewportDefaults to none, ieno fixed ratio is enforced. +
-  * ''KeepInCache'' = [Bool]; NB: If true, the associated textures will always stay in cache. Defaults to false.+
   * ''NoDebug'': When set, no debug rendering will happen in this viewport. Defaults to false.   * ''NoDebug'': When set, no debug rendering will happen in this viewport. Defaults to false.
-  * ''Position'': Defines where the viewport will be placed in the main display. It should be a combination of two attributes. Literal position (example: top left) or position in pixels, from the top left corner. Defaults to top left. +  * ''Camera'': Template name of the camera that will be linked to this viewport. Each [[orxCAMERA|camera template]] will correspond to a unique camera at runtime. This means that if you use more than one viewport linked to the same camerathey will render the same content as seen by this camera.
-  * ''Size'': [Vector]; NB: Size in pixels; +
-  * ''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''+
-  * ''ShaderList'': Defines a list of shaders that will be executed every time this viewport is renderedShader will be activated immediately. Up to 4 shaders can be specified. By default, no shader is used. +
-  * ''Size'': Defines the absolute viewport size, in pixels. This value is only used if none is provided for ''RelativeSize''+
-  * ''TextureList'': Textures used as destination when rendering that viewport; If the specified name doesn't refer to an existing texturea texture of that name will be automatically created, matching the viewport's dimensions; Defaults to screen when not defined. +
-  * ''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.+
  
 ==== Latest config settings for the Development Version ==== ==== Latest config settings for the Development Version ====
 {{section>en:orx:config:developmentversion#&noheader&nofooter&noeditbutton}} {{section>en:orx:config:developmentversion#&noheader&nofooter&noeditbutton}}
  
en/orx/config/settings_structure/orxviewport.txt · Last modified: 2023/09/19 23:42 (6 months ago) by sausage