Window Utilities

Window helper functions for ImGui.

Functions

---

IsWindowAppearing()

IsWindowAppearing() -> boolean

• Description: Returns true if window is appearing
• Returns: boolean - Window appearing state

---

IsWindowCollapsed()

IsWindowCollapsed() -> boolean

• Description: Returns true if window is collapsed
• Returns: boolean - Window collapsed state

---

IsWindowFocused()

IsWindowFocused(flags:ImGuiFocusedFlags|nil) -> boolean

• Description: Returns true if window is focused
• Parameters: flags:ImGuiFocusedFlags|nil - Focus flags (optional)
• Returns: boolean - Window focused state

---

IsWindowHovered()

IsWindowHovered(flags:ImGuiHoveredFlags|nil) -> boolean

• Description: Returns true if window is hovered
• Parameters: flags:ImGuiHoveredFlags|nil - Hover flags (optional)
• Returns: boolean - Window hovered state

---

GetWindowDrawList()

GetWindowDrawList() -> ImDrawList

• Description: Gets window's draw list
• Returns: ImDrawList - Draw list

---

GetWindowDpiScale()

GetWindowDpiScale() -> number

• Description: Gets window's DPI scale
• Returns: number - DPI scale

---

GetWindowPos()

GetWindowPos() -> number, number

• Description: Gets window position
• Returns: number, number - X, Y position

---

GetWindowSize()

GetWindowSize() -> number, number

• Description: Gets window size
• Returns: number, number - Width, height

---

GetWindowWidth()

GetWindowWidth() -> number

• Description: Gets window width
• Returns: number - Window width

---

GetWindowHeight()

GetWindowHeight() -> number

• Description: Gets window height
• Returns: number - Window height

---

GetWindowContentRegionMin()

GetWindowContentRegionMin() -> number, number

• Description: Gets window content region min
• Returns: number, number - Min X, Y

---

GetWindowContentRegionMax()

GetWindowContentRegionMax() -> number, number

• Description: Gets window content region max
• Returns: number, number - Max X, Y

---

GetWindowContentRegionWidth()

GetWindowContentRegionWidth() -> number

• Description: Gets window content region width
• Returns: number - Content region width

---

SetNextWindowPos()

SetNextWindowPos(pos:ImVec2, cond:ImGuiCond|nil, pivot:ImVec2|nil)

• Description: Sets next window position
• Parameters:
  • pos:ImVec2 - Position
  • cond:ImGuiCond|nil - Condition (optional)
  • pivot:ImVec2|nil - Pivot point (optional)
• Returns: None

---

SetNextWindowSize()

SetNextWindowSize(size:ImVec2, cond:ImGuiCond|nil)

• Description: Sets next window size
• Parameters:
  • size:ImVec2 - Window size
  • cond:ImGuiCond|nil - Condition (optional)
• Returns: None

---

SetNextWindowContentSize()

SetNextWindowContentSize(size:ImVec2)

• Description: Sets next window content size
• Parameters: size:ImVec2 - Content size
• Returns: None

---

SetNextWindowCollapsed()

SetNextWindowCollapsed(collapsed:boolean, cond:ImGuiCond|nil)

• Description: Sets next window collapsed state
• Parameters:
  • collapsed:boolean - Collapsed state
  • cond:ImGuiCond|nil - Condition (optional)
• Returns: None

---

SetNextWindowFocus()

SetNextWindowFocus()

• Description: Sets next window to be focused
• Returns: None

---

SetNextWindowBgAlpha()

SetNextWindowBgAlpha(alpha:number)

• Description: Sets next window background alpha
• Parameters: alpha:number - Alpha value
• Returns: None

---

SetNextWindowViewport()

SetNextWindowViewport(viewport:ImGuiViewport)

• Description: Sets next window viewport
• Parameters: viewport:ImGuiViewport - Viewport
• Returns: None

---

SetWindowPos()

SetWindowPos(pos:ImVec2, cond:ImGuiCond|nil)

• Description: Sets current window position
• Parameters:
  • pos:ImVec2 - Position
  • cond:ImGuiCond|nil - Condition (optional)
• Returns: None

---

SetWindowSize()

SetWindowSize(size:ImVec2, cond:ImGuiCond|nil)

• Description: Sets current window size
• Parameters:
  • size:ImVec2 - Window size
  • cond:ImGuiCond|nil - Condition (optional)
• Returns: None

---

SetWindowCollapsed()

SetWindowCollapsed(collapsed:boolean, cond:ImGuiCond|nil)

• Description: Sets current window collapsed state
• Parameters:
  • collapsed:boolean - Collapsed state
  • cond:ImGuiCond|nil - Condition (optional)
• Returns: None

---

SetWindowFocus()

SetWindowFocus()

• Description: Sets current window to be focused
• Returns: None

---

SetWindowFocus()

SetWindowFocus(name:string)

• Description: Sets named window to be focused
• Parameters: name:string - Window name
• Returns: None

---

SetWindowFontScale()

SetWindowFontScale(scale:number)

• Description: Sets current window font scale
• Parameters: scale:number - Font scale
• Returns: None