From 2859143b2f9966dd3fb2096744feed95dc78c195 Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Thu, 3 Aug 2023 08:35:34 +1000 Subject: [PATCH] Add Screen docs --- website/docs/reference/runtime/screen.mdx | 35 +++++++++++++++++++ .../reference/runtime/screen.mdx | 35 +++++++++++++++++++ .../reference/runtime/screen.mdx | 35 +++++++++++++++++++ 3 files changed, 105 insertions(+) create mode 100644 website/docs/reference/runtime/screen.mdx create mode 100644 website/versioned_docs/version-v2.4.0/reference/runtime/screen.mdx create mode 100644 website/versioned_docs/version-v2.5.0/reference/runtime/screen.mdx diff --git a/website/docs/reference/runtime/screen.mdx b/website/docs/reference/runtime/screen.mdx new file mode 100644 index 000000000..d2ccabcfe --- /dev/null +++ b/website/docs/reference/runtime/screen.mdx @@ -0,0 +1,35 @@ +--- +sidebar_position: 9 +--- + +# Screen + +These methods provide information about the currently connected screens. + +### ScreenGetAll + +Returns a list of currently connected screens. + +Go: `ScreenGetAll(ctx context.Context) []screen`
+JS: `ScreenGetAll()` + + +#### Screen + +```go +type Screen struct { + IsCurrent bool + IsPrimary bool + Width int + Height int +} +``` + +```ts +interface Screen { + isCurrent: boolean; + isPrimary: boolean; + width : number + height : number +} +``` diff --git a/website/versioned_docs/version-v2.4.0/reference/runtime/screen.mdx b/website/versioned_docs/version-v2.4.0/reference/runtime/screen.mdx new file mode 100644 index 000000000..d2ccabcfe --- /dev/null +++ b/website/versioned_docs/version-v2.4.0/reference/runtime/screen.mdx @@ -0,0 +1,35 @@ +--- +sidebar_position: 9 +--- + +# Screen + +These methods provide information about the currently connected screens. + +### ScreenGetAll + +Returns a list of currently connected screens. + +Go: `ScreenGetAll(ctx context.Context) []screen`
+JS: `ScreenGetAll()` + + +#### Screen + +```go +type Screen struct { + IsCurrent bool + IsPrimary bool + Width int + Height int +} +``` + +```ts +interface Screen { + isCurrent: boolean; + isPrimary: boolean; + width : number + height : number +} +``` diff --git a/website/versioned_docs/version-v2.5.0/reference/runtime/screen.mdx b/website/versioned_docs/version-v2.5.0/reference/runtime/screen.mdx new file mode 100644 index 000000000..d2ccabcfe --- /dev/null +++ b/website/versioned_docs/version-v2.5.0/reference/runtime/screen.mdx @@ -0,0 +1,35 @@ +--- +sidebar_position: 9 +--- + +# Screen + +These methods provide information about the currently connected screens. + +### ScreenGetAll + +Returns a list of currently connected screens. + +Go: `ScreenGetAll(ctx context.Context) []screen`
+JS: `ScreenGetAll()` + + +#### Screen + +```go +type Screen struct { + IsCurrent bool + IsPrimary bool + Width int + Height int +} +``` + +```ts +interface Screen { + isCurrent: boolean; + isPrimary: boolean; + width : number + height : number +} +```