.texture.txt Files - Revision history

Windwalkr: Redirected page to Texture file

2015-03-03T03:20:40Z

Redirected page to Texture file

← Older revision		Revision as of 03:20, 3 March 2015
Line 1:		Line 1:
	~~=Introduction=~~		#REDIRECT [[Texture file]]
	Files with '''*.texture.txt''' suffix and extension are used to configure texture behavior in Trainz. These files may also control how textures are processed by [[Content Manager]]. These files are located in the same folder as the source texture files, typically .bmp, .tga or .jpg, and make reference to them. These files are generated automatically by the exporter or importer but may be edited by hand when specialization is required.

	~~'''TODO: Merge this document into the~~ [[Texture file]] ~~page and erase this page.'''~~


	~~=Syntax=~~
	~~Each token is specified on a new line. There is no white space on either side of the '=' sign. A empty value is sometimes valid. The syntax is:~~

	~~<token>=<value>~~

	~~Example:~~
	~~Primary=WayCoolTexture.tga~~
	~~Alpha=WayCoolTexture.tga~~
	~~Tile=st~~
	~~AlphaHint=masked~~
	~~Anisotropy=16~~
	~~MagFilter=linear~~
	~~MinFilter=linear~~
	~~MipFilter=linear~~
	~~''(Example only, not recommended settings)''~~


	~~=Tokens=~~
	~~Here is a list of supported tokens. Any other values should not be used.~~


	~~==Primary==~~
	~~Specify texture file name~~
	* '''<texture name>''' - Primary texture. Filename including extension.


	~~==Alpha==~~
	~~Specify alpha channel for texture. Note that if there is only one 32bit file with RGB and A channels, this must still be specified with the same name used in Primary~~
	* '''<texture name>''' - Alpha texture, may be the same or different from the primary


	~~==Tile==~~
	~~Wrap texture addressing horizontally, vertically or both. Otherwise texture is clamped.~~
	* <empty> - '''(default)''' No wrapping
	* '''s''' - Wrap horizontally
	* '''t''' - Wrap vertically
	* '''st''' - Wrap both horizontally and vertically


	~~==Dimension==~~
	~~Number of dimensions the texture has. Not required since only 2D textures are currently supported.~~
	* '''two''' - '''(default)''' Two dimensional
	* '''cube''' - (unsupported)
	* '''volume''' - (unsupported)
	* '''one''' - (unsupported)


	~~==Compression==~~
	~~Compression format used by CMP. '''If this is not supplied, format is chosen automatically'''.~~
	* '''none''' - Do not compress. Warning: Uncompressed textures consume large amounts of memory and slow performance.
	* '''dxt1''' - Suitable for opaque or alpha masked textures
	* '''dxt3''' - Alternately the best for alpha blended textures if the texture contains sharp contrasts. Try DXT5 first.
	* '''dxt5''' - Usually the best for alpha blended textures


	~~==Hint==~~
	~~Texture usage hint, '''for internal use only'''. Note this should NOT be used to try and disble mip mapping.~~
	* '''static''' - '''(default)''' Standard texture resource
	* '''dynamic''' - Texture will be modified in memory


	~~==NormalMapHint==~~
	~~Hint about texture being a normal map. Important to use as this will affect final texture quality. Compression, mip map generation and renormalization of XYZ (RGB) is effected.~~
	* '''none''' - '''(default)''' This is not a normal map
	* '''normalmap''' - This is a normal map


	~~==ModifyMap==~~
	~~Allows the texture to be modified when the texture.txt file is read. Currently this is to allow the green channel (Y axis) to be flipped for normal maps.~~
	* '''none''' - '''(default)''' Do not modify texture
	* '''flipgreen''' - flip green channel which is Y Axis of normal map


	~~==AlphaHint==~~
	~~Specify how the alpha channel is used. Affects final alpha quality. May also affect texture compression and mip generation.~~
	* '''opaque''' - '''(default with no alpha present)''' No alpha channel used.
	* '''semitransparent''' - '''(default with alpha present)''' Alpha blended
	* '''masked''' - Alpha masked


	~~==Anisotropy==~~
	Anisotropic sampling quality. The higher the number, the better the visual quality but at significant performance cost. Where texture quality is needed specify a higher value. Trainz can now control anisotropy via a slider, so the highest setting is used by default.
	* '''1''' - No anisotropic filtering
	* '''2''' - Low
	* '''4''' - Medium
	* '''8''' - High
	* '''16''' - '''(default)''' Very High

	~~==AutoMip==~~
	~~Auto mip map generation. Chris, is this depricated? CMP now generates mip maps at highest quality instead of game load/run time.~~
	* '''none''' - Don't generate mip maps
	* '''default''' - '''(default)''' Whatever the default method is
	* '''fastest''' - Attempt to improve load time at expense of quality
	* '''nicest''' - Attempt to improve quality regardless of time


	~~==MagFilter==~~
	~~Texture sampling filter used when texture is magnified~~
	* '''nearest''' - No blending with neighboring texels
	* '''linear''' - '''(game default)''' Blends with neighboring texels for smooth zoom effect
	* '''default''' - '''(default)''' Game default


	~~==MinFilter==~~
	~~Texture sampling filter used when texture is minified~~
	* '''nearest''' - No blending with neighboring texels
	* '''linear''' - '''(game default)''' Blends with neighboring texels for smooth shrink effect
	* '''default''' - '''(default)''' Game default


	~~==MipFilter==~~
	~~Texture sampling filter used on mip map selection~~
	* '''nearest''' - No blending with other mip maps
	* '''linear''' - '''(game default)''' Smooth blendig between mip maps (Note, operates independently but should be used in conjunction with anisotropic sampling)
	* '''default''' - '''(default)''' Game default
	* '''none''' - Disable mip map generation in CMP and use in game. Specifically for user interface elements.


	~~=Comments & Suggestions=~~
	* ''Hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for interface textures.

Tonyhilliam at 01:26, 31 March 2014

2014-03-31T01:26:28Z

← Older revision		Revision as of 01:26, 31 March 2014
Line 55:		Line 55:
	Compression format used by CMP. '''If this is not supplied, format is chosen automatically'''.		Compression format used by CMP. '''If this is not supplied, format is chosen automatically'''.
	* '''none''' - Do not compress. Warning: Uncompressed textures consume large amounts of memory and slow performance.		* '''none''' - Do not compress. Warning: Uncompressed textures consume large amounts of memory and slow performance.
	* '''~~DXT1~~''' - Suitable for opaque or alpha masked textures		* '''dxt1''' - Suitable for opaque or alpha masked textures
	* '''~~DXT3~~''' - Alternately the best for alpha blended textures if the texture contains sharp contrasts. Try DXT5 first.		* '''dxt3''' - Alternately the best for alpha blended textures if the texture contains sharp contrasts. Try DXT5 first.
	* '''~~DXT5~~''' - Usually the best for alpha blended textures		* '''dxt5''' - Usually the best for alpha blended textures

Jamesmoody: /* Anisotropy */

2013-07-30T02:52:06Z

Anisotropy

← Older revision		Revision as of 02:52, 30 July 2013
Line 86:		Line 86:

	==Anisotropy==		==Anisotropy==
	Anisotropic sampling quality. The higher the number, the better the visual quality but at significant performance cost. Where texture quality is needed specify a higher value.		Anisotropic sampling quality. The higher the number, the better the visual quality but at significant performance cost. Where texture quality is needed specify a higher value. Trainz can now control anisotropy via a slider, so the highest setting is used by default.
	* '''1''' - ~~'''(default)'''~~ No anisotropic filtering		* '''1''' - No anisotropic filtering
	* '''2''' - Low		* '''2''' - Low
	* '''4''' - Medium		* '''4''' - Medium
	* '''8''' - High		* '''8''' - High
	* '''16''' - Very High		* '''16''' - '''(default)''' Very High


	==AutoMip==		==AutoMip==

Pev: Page redundant

2012-08-22T15:03:27Z

Page redundant

← Older revision		Revision as of 15:03, 22 August 2012
Line 126:		Line 126:
	=Comments & Suggestions=		=Comments & Suggestions=
	* ''Hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for interface textures.		* ''Hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for interface textures.

	~~[[Category:File formats]]~~

Retro00064: /* Comments & Suggestions */ moved page to Category:File formats.

2011-09-05T02:08:13Z

Comments & Suggestions: moved page to Category:File formats.

← Older revision		Revision as of 02:08, 5 September 2011
Line 127:		Line 127:
	* ''Hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for interface textures.		* ''Hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for interface textures.

	[[Category:~~Modeling~~]]		[[Category:File formats]]

Retro00064: /* Comments & Suggestions */ added Category:Modeling.

2011-09-03T23:56:27Z

Comments & Suggestions: added Category:Modeling.

← Older revision		Revision as of 23:56, 3 September 2011
Line 126:		Line 126:
	=Comments & Suggestions=		=Comments & Suggestions=
	* ''Hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for interface textures.		* ''Hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for interface textures.

			[[Category:Modeling]]

Retro00064: /* Comments & Suggestions */ corrected names of fields

2011-02-11T01:12:48Z

Comments & Suggestions: corrected names of fields

← Older revision		Revision as of 01:12, 11 February 2011
Line 125:		Line 125:

	=Comments & Suggestions=		=Comments & Suggestions=
	* ''~~hint~~'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''~~anisotropic~~'' should be used to improve texture quality and ''~~mipfilter~~=none'' should be used to disable mip mapping only for interface textures.		* ''Hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for interface textures.

Windwalkr: 1 revision

2010-02-03T13:58:19Z

1 revision

← Older revision	Revision as of 13:58, 3 February 2010
(No difference)

imported>Greg: more defaults

2008-10-29T04:03:22Z

more defaults

New page

=Introduction=
Files with '''*.texture.txt''' suffix and extension are used to configure texture behavior in Trainz. These files may also control how textures are processed by [[Content Manager]]. These files are located in the same folder as the source texture files, typically .bmp, .tga or .jpg, and make reference to them. These files are generated automatically by the exporter or importer but may be edited by hand when specialization is required.

'''TODO: Merge this document into the [[Texture file]] page and erase this page.'''

=Syntax=
Each token is specified on a new line. There is no white space on either side of the '=' sign. A empty value is sometimes valid. The syntax is:

<token>=<value>

Example:
Primary=WayCoolTexture.tga
Alpha=WayCoolTexture.tga
Tile=st
AlphaHint=masked
Anisotropy=16
MagFilter=linear
MinFilter=linear
MipFilter=linear
''(Example only, not recommended settings)''

=Tokens=
Here is a list of supported tokens. Any other values should not be used.

==Primary==
Specify texture file name
* '''<texture name>''' - Primary texture. Filename including extension.

==Alpha==
Specify alpha channel for texture. Note that if there is only one 32bit file with RGB and A channels, this must still be specified with the same name used in Primary
* '''<texture name>''' - Alpha texture, may be the same or different from the primary

==Tile==
Wrap texture addressing horizontally, vertically or both. Otherwise texture is clamped.
* <empty> - '''(default)''' No wrapping
* '''s''' - Wrap horizontally
* '''t''' - Wrap vertically
* '''st''' - Wrap both horizontally and vertically

==Dimension==
Number of dimensions the texture has. Not required since only 2D textures are currently supported.
* '''two''' - '''(default)''' Two dimensional
* '''cube''' - (unsupported)
* '''volume''' - (unsupported)
* '''one''' - (unsupported)

==Compression==
Compression format used by CMP. '''If this is not supplied, format is chosen automatically'''.
* '''none''' - Do not compress. Warning: Uncompressed textures consume large amounts of memory and slow performance.
* '''DXT1''' - Suitable for opaque or alpha masked textures
* '''DXT3''' - Alternately the best for alpha blended textures if the texture contains sharp contrasts. Try DXT5 first.
* '''DXT5''' - Usually the best for alpha blended textures

==Hint==
Texture usage hint, '''for internal use only'''. Note this should NOT be used to try and disble mip mapping.
* '''static''' - '''(default)''' Standard texture resource
* '''dynamic''' - Texture will be modified in memory

==NormalMapHint==
Hint about texture being a normal map. Important to use as this will affect final texture quality. Compression, mip map generation and renormalization of XYZ (RGB) is effected.
* '''none''' - '''(default)''' This is not a normal map
* '''normalmap''' - This is a normal map

==ModifyMap==
Allows the texture to be modified when the texture.txt file is read. Currently this is to allow the green channel (Y axis) to be flipped for normal maps.
* '''none''' - '''(default)''' Do not modify texture
* '''flipgreen''' - flip green channel which is Y Axis of normal map

==AlphaHint==
Specify how the alpha channel is used. Affects final alpha quality. May also affect texture compression and mip generation.
* '''opaque''' - '''(default with no alpha present)''' No alpha channel used.
* '''semitransparent''' - '''(default with alpha present)''' Alpha blended
* '''masked''' - Alpha masked

==Anisotropy==
Anisotropic sampling quality. The higher the number, the better the visual quality but at significant performance cost. Where texture quality is needed specify a higher value.
* '''1''' - '''(default)''' No anisotropic filtering
* '''2''' - Low
* '''4''' - Medium
* '''8''' - High
* '''16''' - Very High

==AutoMip==
Auto mip map generation. Chris, is this depricated? CMP now generates mip maps at highest quality instead of game load/run time.
* '''none''' - Don't generate mip maps
* '''default''' - '''(default)''' Whatever the default method is
* '''fastest''' - Attempt to improve load time at expense of quality
* '''nicest''' - Attempt to improve quality regardless of time

==MagFilter==
Texture sampling filter used when texture is magnified
* '''nearest''' - No blending with neighboring texels
* '''linear''' - '''(game default)''' Blends with neighboring texels for smooth zoom effect
* '''default''' - '''(default)''' Game default

==MinFilter==
Texture sampling filter used when texture is minified
* '''nearest''' - No blending with neighboring texels
* '''linear''' - '''(game default)''' Blends with neighboring texels for smooth shrink effect
* '''default''' - '''(default)''' Game default

==MipFilter==
Texture sampling filter used on mip map selection
* '''nearest''' - No blending with other mip maps
* '''linear''' - '''(game default)''' Smooth blendig between mip maps (Note, operates independently but should be used in conjunction with anisotropic sampling)
* '''default''' - '''(default)''' Game default
* '''none''' - Disable mip map generation in CMP and use in game. Specifically for user interface elements.

=Comments & Suggestions=
* ''hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''anisotropic'' should be used to improve texture quality and ''mipfilter=none'' should be used to disable mip mapping only for interface textures.