Component:DesktopTextureProvider: Difference between revisions

Latest revision as of 15:38, 11 November 2024

Component image

**Desktop Texture Provider** component as seen in the Scene Inspector

The DesktopTextureProvider component only works in user space. This component is an ITexture2D and can be used as a texture. This texture is able to display what is on any particular monitor on a user's machine. This component is commonly used in the desktop tab on a user's Dash.

Fields

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. Some components stop their functionality when this field is disabled, but some don't.
`DisplayIndex`	Int	What monitor to get image data for.

Usage

This should not be used by the user, but it could be used to make a special facet. Insert the component into a texture field on a material to display it.

Examples

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=DesktopTextureProviderComponent.png
 |Name=Desktop Texture Provider
 }}
+The '''DesktopTextureProvider''' component only works in user space. This component is an [[Type:ITexture2D|ITexture2D]] and can be used as a texture. This texture is able to display what is on any particular monitor on a user's machine. This component is commonly used in the desktop tab on a user's [[Dash]].
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|DisplayIndex|Int|
+|DisplayIndex|Int| What monitor to get image data for.
 }}
 <!--T:3-->
 == Usage ==
+This should not be used by the user, but it could be used to make a special facet. Insert the component into a texture field on a material to display it.
 <!--T:4-->
@@ Line 23: / Line 24: @@
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Desktop Texture Provider]]
 [[Category:Components:Assets{{#translation:}}|Desktop Texture Provider]]