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    
execute(control: RenderTargetDebugControl, vp: ScreenViewport): void    

Inherited methods

Name Inherited from Description
parseAndRun(..._args: string[]): boolean Tool Run this instance of a tool using a series of string arguments.
run(_args: any[]): boolean RenderTargetDebugControlTool  
register(namespace?: I18NNamespace, i18n?: I18N): void Static Tool Register this Tool class with the ($ToolRegistry$refLinkSource=frontend-devtools/D:/vsts_a/3/s/core/frontend-devtools/node_modules/@bentley/imodeljs-frontend/lib/tools/Tool.d.ts@241).

Properties

Name Type Description
toolId Static string    

Inherited properties

Name Type Inherited from Description
description Static string Tool Get the localized description for this Tool class.
description string Tool Get the localized description string from this Tool's class
englishKeyin Static string Tool Get the English keyin string for this Tool class.
flyover Static string Tool Get the localized flyover for this Tool class.
flyover string Tool Get the localized flyover string from this Tool's class
hidden Static boolean Tool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N Tool The internationalization services instance used to translate strings from the namespace.
iconSpec Static string Tool The icon for this Tool.
iconSpec string Tool Get the iconSpec from this Tool's class.
keyin Static string Tool Get the localized keyin string for this Tool class.
keyin string Tool Get the localized keyin string from this Tool's class
maxArgs Static number | undefined Tool The maximum number of arguments allowed by parseAndRun, or undefined if there is no maximum.
minArgs Static number Tool The minimum number of arguments allowed by parseAndRun.
namespace Static I18NNamespace Tool The I18NNamespace that provides localized strings for this Tool.
toolId string Tool Get the toolId string for this Tool class.

Defined in

Last Updated: 08 January, 2020