User Tools

Site Tools


en:orx:config:settings_structure:orxgraphic

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:orx:config:settings_structure:orxgraphic [2017/05/29 21:50 (7 years ago)] – external edit 127.0.0.1en:orx:config:settings_structure:orxgraphic [2023/08/25 00:58 (7 months ago)] (current) – [Details] sausage
Line 4: Line 4:
  
 <code ini>[GraphicTemplate] <code ini>[GraphicTemplate]
-Texture       = path/to/ImageFile+Texture       = path/to/ImageFile.ext
 TextureOrigin = <vector> TextureOrigin = <vector>
 TextureSize   = <vector> TextureSize   = <vector>
 +KeepInCache   = <bool>
 Text          = TextTemplate Text          = TextTemplate
-Alpha         = <float> +Pivot         (center (truncate | round)) (left | right) (top | bottom| <vector>
-BlendMode     = alpha | multiply | add | none +
-Color         = <vector> +
-Flip          = x | y | both +
-Pivot         = center(+truncate | round) left | right top | bottom | <vector>;+
 Repeat        = <vector> Repeat        = <vector>
-Smoothing     = <bool></code> +Flip          = x | y | both 
 +Color         = <vector> 
 +RGB           = <vector> 
 +HSL           = <vector> 
 +HSV           = <vector> 
 +Alpha         = <float> 
 +BlendMode     = alpha | multiply | add | premul | none 
 +Smoothing     = <bool> 
 +</code>
  
 ==== Details ==== ==== Details ====
  
 Here's a list of the available properties for an ''orxGRAPHIC'' structure: Here's a list of the available properties for an ''orxGRAPHIC'' structure:
-  * ''Texture'': Specifies which bitmap file to use as texture for our graphic object. If none is provided, a valid [[orxTEXT]] should be given in the property ''Text''. If the value is ''pixel'', a 1x1 white bitmap with full opacity will be used.+ 
 +  * ''Texture'': Specifies which bitmap file to use as texture for our graphic object. If provided, text data will be ignored. If none is provided, a valid [[orxTEXT]] should be given in the property ''Text''. If set to 'pixel', a 1x1 opaque white bitmap will be used. If set to 'transparent', a 1x1 transparent black bitmap will be used. If it begins with the character '$', it will be used as a locale key instead of as a plain texture. It will then be automatically updated upon a new language selection.
   * ''TextureOrigin'': Specifies the top left corner to use in the bitmap file, in pixels (Z coordinate being ignored). By default its value is (0, 0, 0) which means the texture for the graphic object will begin at the top left of the bitmap file. This property is ignored for Text data.   * ''TextureOrigin'': Specifies the top left corner to use in the bitmap file, in pixels (Z coordinate being ignored). By default its value is (0, 0, 0) which means the texture for the graphic object will begin at the top left of the bitmap file. This property is ignored for Text data.
   * ''TextureSize'': Specifies the size, in pixels, of the bitmap file to use as texture (Z coordinate being ignored). By default it will use the whole bitmap, ie. its value will be the size of the bitmap. This property is ignored for Text data.   * ''TextureSize'': Specifies the size, in pixels, of the bitmap file to use as texture (Z coordinate being ignored). By default it will use the whole bitmap, ie. its value will be the size of the bitmap. This property is ignored for Text data.
-  * ''Text'': If no ''Texture'' is provided, this needs to be a valid [[orxTEXT]] entry that will be used as content for the graphic object. +  * ''KeepInCache'': If true, the associated texture will always stay in cache. This value is ignored for a text. Defaults to false. 
-  * ''Alpha'': Defines the opacity for this graphic object (ranges between 0.0 and 1.0). +  * ''Text'': If no ''Texture'' is provided, this needs to be a valid [[orxTEXT]] entry that will be used as content for the graphic object. Will be ignored if valid texture is provided
-  * ''BlendMode'': Defines which [[wp>Blend_modes|blend mode]] will be used when rendering this graphic object. By default its value is none which means its owner object will determine which [[wp>Blend_modes|blend mode]] will be used (generally alpha blending). +  * ''Pivot'': Defines where the pivot ((aka HotSpot)) of the graphic object is. It can be defined either relatively using the center, top, bottom, left and right keywords. Truncate and round will adjust pivot values if they are not integers, or absolutely by giving a coordinate vector (in pixels). z is ignored for 2D graphics
-  * ''Color'': Specifies color applied on top of the graphic object (ie. a tint). If none is specified, white color will be used (ie. no tint). +  * ''Repeat'': Specifies if the graphic object should be repeated (so as to achieve a tiling effect) when rendered. This only works for textures and not texts! The vector specifies the number of times it will be repeated on X and Y axes (Z being ignored). By default, its value is (1, 1, 0), ie. no repeat. Other values must be strictly positive. This will be ignored for text data. 
-  * ''Flip'': Defines if the graphic object should be flipped when rendered. It can be flipped on either X or Y axis or both. By default, no flipping is used. this property is ignored for Text data+  * ''Color'': Specifies a color applied on top of the graphic object. Values are RGB from 0 to 255, eg: (255,128,0). Official HTML web color names are also supported (this list can be extended through the Color config section)If none is specified, white color will be used. 
-  * ''Pivot'': Defines where the pivot ((aka HotSpot)) of the graphic object is. It can be defined either relatively using the center, top, bottom, left and right keywords ((additionally, truncate or round can be used for centered pivot when its coordinates wouldn't be integers)), or absolutely by giving a coordinate vector (in pixels). +  * ''RGB'': Values are RGB from 0.0 to 1.0. Will be used only if Color isn't defined. 
-  * ''Repeat'': Specifies if the graphic object should be repeated (so as to achieve a tiling effect) when rendered. This only works for textures and not texts! The vector specifies the number of times it will be repeated on X and Y axes (Z being ignored). By default, its value is (1, 1, 0), ie. no repeat. This property is ignored for Text data. +  * ''HSL'': Values are HSL from 0.0 to 1.0. Will be used only if Color and RGB aren't defined. 
-  * ''Smoothing'': Specifies if the graphic object should be rendered with antialiasing or notBy default its value is ''default'' which means its owner object will decide if it will use antialiasing or not. This property is ignored for Text data.+  * ''HSV'': Values are HSV from 0.0 to 1.0. Will be used only if Color, RGB and HSL aren't defined. 
 +  * ''BlendMode'': Defines which [[wp>Blend_modes|blend mode]] will be used when rendering this graphic object. By default its value is none which means its owner object will determine which [[wp>Blend_modes|blend mode]] will be used (generally alpha blending). Default value is alpha. 
 +  * ''Smoothing'': Specifies if the graphic object should be rendered with antialiasing or not. If no value is provided, the default is taken from the object settings. This will be ignored for text data.
  
  
en/orx/config/settings_structure/orxgraphic.1496119845.txt.gz · Last modified: 2017/05/30 00:50 (7 years ago) (external edit)