Api Sandbox WebSurface
class

WebSurface

public sealed class WebSurface

Enables rendering and interacting with a webpage

Properties

Name Type Description
IsLimited Boolean
OnTexture TextureChangedDelegate Called when the texture has changed and should be updated
PageTitle String
Url String The current Url
Size Vector2 The size of the browser
Cursor String
HasKeyFocus Boolean Tell the html control if it has key focus currently, controls showing the I-beam cursor in text controls amongst other things
ScaleFactor Single DPI Scaling factor
InBackgroundMode Boolean Enable/disable low-resource background mode, where javascript and repaint timers are throttled, resources are more aggressively purged from memory, and audio/video elements are paused. When background mode is enabled, all HTML5 video and audio objects will execute ".pause()" and gain the property "._steam_background_paused = 1". When background mode is disabled, any video or audio objects with that property will resume with ".play()".

Methods

virtual Void Dispose()
Void TellMouseMove(Vector2 position)

Tell the browser the mouse has moved

Void TellMouseWheel(Int32 delta)

Tell the browser the mouse wheel has moved

delta
Void TellMouseButton(MouseButtons button, Boolean state)

Tell the browser a mouse button has been pressed

Void TellChar(UInt32 unicodeKey, KeyboardModifiers modifiers)

Tell the browser a unicode key has been pressed

Void TellKey(UInt32 virtualKeyCode, KeyboardModifiers modifiers, Boolean state)

Tell the browser a key has been pressed or released

Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.WebSurface