add documentpagetexture component |
add info, format, add templates |
||
(9 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<languages></languages> | |||
<translate> | |||
{{Infobox Component | |||
|Image=DocumentPageTextureComponent.png | |||
|Name=Document Page Texture | |||
}} | |||
The '''DocumentPageTexture''' component generates texture data using a document file like a PDF which can be displayed using a [[material]] in a [[Component:MeshRenderer]] or [[UIX]]. | |||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|HighPriorityIntegration|Bool| | |HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}} | ||
|FilterMode|TextureFilterMode| | |FilterMode|TextureFilterMode| {{Template:Texture FilterMode Field}} | ||
|AnisotropicLevel|Int| | |AnisotropicLevel|Int| {{Template:Texture AnisotropicLevel Field}} | ||
|WrapModeU|TextureWrapMode| | |WrapModeU|TextureWrapMode| {{Template:Texture WrapMode Field|X}} | ||
|WrapModeV|TextureWrapMode| | |WrapModeV|TextureWrapMode| {{Template:Texture WrapMode Field|Y}} | ||
|MipmapBias|Float| | |MipmapBias|Float| {{Template:Texture MipmapBias Field}} | ||
|Profile|ColorProfile| | |Profile|ColorProfile| {{Template:Texture Profile Field}} | ||
|Size| | |Size|Int2| {{Template:ProceduralTexture Size Field}} | ||
| | |Document|{{RootFieldType|AssetRef`1|Document}}|TypeAdv9=true| The document to display using this texture. | ||
|Document| | |PageIndex|Int| The page in <code>Document</code> to display as the texture data. | ||
|PageIndex|Int| | |PageRegion|Rect| The area of the in <code>Document</code> to display on page <code>PageIndex</code> | ||
|PageRegion|Rect| | }} | ||
== Sync Delegates == | |||
{{Table ComponentTriggers | |||
|BakeTexture()|[[Type:Action|Action]]| {{Template:BakeTexture Sync Method}} | |||
}} | }} | ||
== Usage == | |||
This component is auto generated as part of a document viewer when importing PDF files. Simply import a PDF file into the game to generate a viewer that uses this component as part of how it works. | |||
== Examples == | |||
{{stub}} | |||
== See Also == | |||
* [[Type:Document]] | |||
[[Category:Components:Assets: | </translate> | ||
[[Category:Components:Assets:Procedural Textures{{#translation:}}|Document Page Texture]] | |||
[[Category:Components{{#translation:}}|Document Page Texture]] |
Latest revision as of 15:58, 19 November 2024
Component image
The DocumentPageTexture component generates texture data using a document file like a PDF which can be displayed using a material in a Component:MeshRenderer or UIX.
Fields
Name | Type | Description |
---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. |
HighPriorityIntegration
|
Bool | If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes. |
FilterMode
|
TextureFilterMode | How to handle the interpolation between pixels. |
AnisotropicLevel
|
Int | The levels of Anisotropic filtering distances when using Anisotropic for FilterMode
|
WrapModeU
|
TextureWrapMode | How to repeat or mirror the texture along the X axis. this goes into affect when X values are outside of the range [0.0 to 1.0]. |
WrapModeV
|
TextureWrapMode | How to repeat or mirror the texture along the Y axis. this goes into affect when Y values are outside of the range [0.0 to 1.0]. |
MipmapBias
|
Float | Whether to see lower resolution versions of the texture closer up or not (MipMaps). |
Profile
|
ColorProfile | The color profile to use for this texture's rendering. |
Size
|
Int2 | The size of the procedural texture in pixels. |
Document
|
Document | The document to display using this texture. |
PageIndex
|
Int | The page in Document to display as the texture data.
|
PageRegion
|
Rect | The area of the in Document to display on page PageIndex
|
Sync Delegates
Method Name | Method type and Arguments. | Description |
---|---|---|
BakeTexture()
|
Action | BakeTexture first generates a Component:StaticTexture2D that is the same as this procedural texture. The resulting static texture replaces every reference to the original procedural texture. Lastly the original procedural texture is deleted. |
Usage
This component is auto generated as part of a document viewer when importing PDF files. Simply import a PDF file into the game to generate a viewer that uses this component as part of how it works.
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.