Component:BlitToDisplay

From Resonite Wiki
Revision as of 16:50, 14 October 2024 by 989onan (talk | contribs) (→‎Examples: fix typo)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
Blit To Display component as seen in the Scene Inspector

BlitToDisplay is a component that is able to make a user's game window display a 2d texture of any kind (including render textures) and is also able to create new game windows to display images as well.

Usage

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.
TargetUser direct UserRef The user to display the image on their screen for. Using the local user does work.
Texture ITexture2D The texture to display to the screen. A render texture may be used here.
DisplayIndex Int which game window to display Texture to. If the window number doesn't exist, one is created automatically. If 0 is used, the main game window will be used.
BackgroundColor ColorX The color to display behind the image.
FlipHorizontally Bool flip the image horizontally before displaying to the screen.
FlipVertically Bool flip the image vertically before displaying to the screen.

Behavior

Disabling this component does not disable its effects. Setting TargetUser to null does though. New windows created by this component will close the game if closed. It is unknown if this is a bug. This component can and will blind desktop users if DisplayIndex is set to 0 and TargetUser targets a desktop user.

Examples

989onan's MMD player uses this to display the animated camera for the dances to the main screen.

See Also