ImGuiViewportFlags.hsc

{-# LANGUAGE CApiFFI #-}
{-# LANGUAGE PatternSynonyms #-}

-- This file was generated by dear-bindings-ffi. Do not edit by hand.

module DearImGui.Raw.Enums.ImGuiViewportFlags
  ( ImGuiViewportFlags
  , pattern CanHostOtherWindows
  , pattern IsFocused
  , pattern IsMinimized
  , pattern IsPlatformMonitor
  , pattern IsPlatformWindow
  , pattern NoAutoMerge
  , pattern NoDecoration
  , pattern NoFocusOnAppearing
  , pattern NoFocusOnClick
  , pattern NoInputs
  , pattern NoRendererClear
  , pattern NoTaskBarIcon
  , pattern None
  , pattern OwnedByApp
  , pattern TopMost
  ) where

import Foreign.C.Types

#include "dcimgui_nodefaultargfunctions.h"

-- typedefs

-- | Flags stored in ImGuiViewport::Flags, giving indications to the platform backends.
type ImGuiViewportFlags = CInt

-- enums

pattern None :: ImGuiViewportFlags
pattern None = #{const ImGuiViewportFlags_None}

-- | Represent a Platform Window
pattern IsPlatformWindow :: ImGuiViewportFlags
pattern IsPlatformWindow = #{const ImGuiViewportFlags_IsPlatformWindow}

-- | Represent a Platform Monitor (unused yet)
pattern IsPlatformMonitor :: ImGuiViewportFlags
pattern IsPlatformMonitor = #{const ImGuiViewportFlags_IsPlatformMonitor}

-- | Platform Window: Is created/managed by the user application? (rather than our backend)
pattern OwnedByApp :: ImGuiViewportFlags
pattern OwnedByApp = #{const ImGuiViewportFlags_OwnedByApp}

-- | Platform Window: Disable platform decorations: title bar, borders, etc. (generally set all windows, but if ImGuiConfigFlags_ViewportsDecoration is set we only set this on popups/tooltips)
pattern NoDecoration :: ImGuiViewportFlags
pattern NoDecoration = #{const ImGuiViewportFlags_NoDecoration}

-- | Platform Window: Disable platform task bar icon (generally set on popups/tooltips, or all windows if ImGuiConfigFlags_ViewportsNoTaskBarIcon is set)
pattern NoTaskBarIcon :: ImGuiViewportFlags
pattern NoTaskBarIcon = #{const ImGuiViewportFlags_NoTaskBarIcon}

-- | Platform Window: Don't take focus when created.
pattern NoFocusOnAppearing :: ImGuiViewportFlags
pattern NoFocusOnAppearing = #{const ImGuiViewportFlags_NoFocusOnAppearing}

-- | Platform Window: Don't take focus when clicked on.
pattern NoFocusOnClick :: ImGuiViewportFlags
pattern NoFocusOnClick = #{const ImGuiViewportFlags_NoFocusOnClick}

-- | Platform Window: Make mouse pass through so we can drag this window while peaking behind it.
pattern NoInputs :: ImGuiViewportFlags
pattern NoInputs = #{const ImGuiViewportFlags_NoInputs}

-- | Platform Window: Renderer doesn't need to clear the framebuffer ahead (because we will fill it entirely).
pattern NoRendererClear :: ImGuiViewportFlags
pattern NoRendererClear = #{const ImGuiViewportFlags_NoRendererClear}

-- | Platform Window: Avoid merging this window into another host window. This can only be set via ImGuiWindowClass viewport flags override (because we need to now ahead if we are going to create a viewport in the first place!).
pattern NoAutoMerge :: ImGuiViewportFlags
pattern NoAutoMerge = #{const ImGuiViewportFlags_NoAutoMerge}

-- | Platform Window: Display on top (for tooltips only).
pattern TopMost :: ImGuiViewportFlags
pattern TopMost = #{const ImGuiViewportFlags_TopMost}

-- | Viewport can host multiple imgui windows (secondary viewports are associated to a single window). // FIXME: In practice there's still probably code making the assumption that this is always and only on the MainViewport. Will fix once we add support for "no main viewport".
pattern CanHostOtherWindows :: ImGuiViewportFlags
pattern CanHostOtherWindows = #{const ImGuiViewportFlags_CanHostOtherWindows}

-- | Output status flags (from Platform)
-- Platform Window: Window is minimized, can skip render. When minimized we tend to avoid using the viewport pos/size for clipping window or testing if they are contained in the viewport.
pattern IsMinimized :: ImGuiViewportFlags
pattern IsMinimized = #{const ImGuiViewportFlags_IsMinimized}

-- | Platform Window: Window is focused (last call to Platform_GetWindowFocus() returned true)
pattern IsFocused :: ImGuiViewportFlags
pattern IsFocused = #{const ImGuiViewportFlags_IsFocused}