API Reference > frontend-devTools > Tools > ToggleReadPixelsTool

ToggleReadPixelsTool Class

Beta  

Toggles between normal rendering and rendering as if drawing to an off-screen framebuffer for element locate. Useful for debugging locate issues.

Extends

Methods

Name Description
constructor(..._args: any[]): ToggleReadPixelsTool    

Inherited methods

Name Inherited from Description
execute(control: RenderTargetDebugControl, vp: ScreenViewport): void Protected RenderTargetDebugControlToggleTool  
parseAndRun(...args: string[]): boolean RenderTargetDebugControlToggleTool Run this instance of a tool using a series of string arguments.
run(_args: any[]): boolean RenderTargetDebugControlToggleTool  
register(namespace?: I18NNamespace, i18n?: I18N): void Static RenderTargetDebugControlToggleTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
aspect Accessor ReadOnly DebugControlBoolean    
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
description Accessor ReadOnly string RenderTargetDebugControlToggleTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string RenderTargetDebugControlToggleTool Get the localized description for this Tool class. This returns the value of "tools." + this.toolId + ".description" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
RenderTargetDebugControlToggleTool.flyover is returned.
englishKeyin Accessor StaticReadOnly string RenderTargetDebugControlToggleTool Get the English keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
flyover Accessor ReadOnly string RenderTargetDebugControlToggleTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string RenderTargetDebugControlToggleTool Get the localized flyover for this Tool class. This returns the value of "tools." + this.toolId + ".flyover" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
RenderTargetDebugControlToggleTool.keyin is returned.
hidden Static boolean RenderTargetDebugControlToggleTool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N RenderTargetDebugControlToggleTool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string RenderTargetDebugControlToggleTool Get the iconSpec from this Tool's class.
iconSpec Static string RenderTargetDebugControlToggleTool The icon for this Tool.
keyin Accessor ReadOnly string RenderTargetDebugControlToggleTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string RenderTargetDebugControlToggleTool Get the localized keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
maxArgs Accessor StaticReadOnly number RenderTargetDebugControlToggleTool  
minArgs Accessor StaticReadOnly number RenderTargetDebugControlToggleTool  
namespace Static I18NNamespace RenderTargetDebugControlToggleTool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string RenderTargetDebugControlToggleTool Get the toolId string for this Tool class. This string is used to identify the Tool in the ToolRegistry and is used to localize
the keyin, description, etc. from the current locale.

Defined in

Last Updated: 11 June, 2024