WindowProperties

from panda3d.core import WindowProperties

class WindowProperties

Bases: DTOOL_SUPER_BASE

A container for the various kinds of properties we might ask to have on a graphics window before we open it. This also serves to hold the current properties for a window after it has been opened.

Inheritance diagram

MAbsolute = 0

MConfined = 2

MRelative = 1

M_absolute = 0

M_confined = 2

M_relative = 1

ZBottom = 0

ZNormal = 1

ZTop = 2

Z_bottom = 0

Z_normal = 1

Z_top = 2

__init__(*args, **kwargs)

addProperties()

C++ Interface: add_properties(const WindowProperties self, const WindowProperties other)

/**

• Sets any properties that are explicitly specified in other on this object.

• Leaves other properties unchanged.

*/

add_properties()

C++ Interface: add_properties(const WindowProperties self, const WindowProperties other)

/**

• Sets any properties that are explicitly specified in other on this object.

• Leaves other properties unchanged.

*/

assign()

C++ Interface: assign(const WindowProperties self, const WindowProperties copy)

clear()

C++ Interface: clear(const WindowProperties self)

/**

• Unsets all properties that have been specified so far, and resets the

• WindowProperties structure to its initial empty state.

*/

clearCursorFilename()

C++ Interface: clear_cursor_filename(const WindowProperties self)

/**

• Removes the cursor_filename specification from the properties.

*/

clearCursorHidden()

C++ Interface: clear_cursor_hidden(const WindowProperties self)

/**

• Removes the cursor_hidden specification from the properties.

*/

clearDefault()

C++ Interface: clear_default()

/**

• Returns the “default” WindowProperties to whatever is specified in the

• user’s config file.

*/

clearFixedSize()

C++ Interface: clear_fixed_size(const WindowProperties self)

/**

• Removes the fixed_size specification from the properties.

*/

clearForeground()

C++ Interface: clear_foreground(const WindowProperties self)

/**

• Removes the foreground specification from the properties.

*/

clearFullscreen()

C++ Interface: clear_fullscreen(const WindowProperties self)

/**

• Removes the fullscreen specification from the properties.

*/

clearIconFilename()

C++ Interface: clear_icon_filename(const WindowProperties self)

/**

• Removes the icon_filename specification from the properties.

*/

clearMaximized()

C++ Interface: clear_maximized(const WindowProperties self)

/**

• Removes the maximized specification from the properties.

*/

clearMinimized()

C++ Interface: clear_minimized(const WindowProperties self)

/**

• Removes the minimized specification from the properties.

*/

clearMouseMode()

C++ Interface: clear_mouse_mode(const WindowProperties self)

/**

• Removes the mouse_mode specification from the properties.

*/

clearOpen()

C++ Interface: clear_open(const WindowProperties self)

/**

• Removes the open specification from the properties.

*/

clearOrigin()

C++ Interface: clear_origin(const WindowProperties self)

/**

• Removes the origin specification from the properties.

*/

clearParentWindow()

C++ Interface: clear_parent_window(const WindowProperties self)

/**

• Removes the S_parent_window specification from the properties.

*/

clearRawMice()

C++ Interface: clear_raw_mice(const WindowProperties self)

/**

• Removes the raw_mice specification from the properties.

*/

clearSize()

C++ Interface: clear_size(const WindowProperties self)

/**

• Removes the size specification from the properties.

*/

clearTitle()

C++ Interface: clear_title(const WindowProperties self)

/**

• Removes the title specification from the properties.

*/

clearUndecorated()

C++ Interface: clear_undecorated(const WindowProperties self)

/**

• Removes the undecorated specification from the properties.

*/

clearZOrder()

C++ Interface: clear_z_order(const WindowProperties self)

/**

• Removes the z_order specification from the properties.

*/

clear_cursor_filename()

C++ Interface: clear_cursor_filename(const WindowProperties self)

/**

• Removes the cursor_filename specification from the properties.

*/

clear_cursor_hidden()

C++ Interface: clear_cursor_hidden(const WindowProperties self)

/**

• Removes the cursor_hidden specification from the properties.

*/

clear_default()

C++ Interface: clear_default()

/**

• Returns the “default” WindowProperties to whatever is specified in the

• user’s config file.

*/

clear_fixed_size()

C++ Interface: clear_fixed_size(const WindowProperties self)

/**

• Removes the fixed_size specification from the properties.

*/

clear_foreground()

C++ Interface: clear_foreground(const WindowProperties self)

/**

• Removes the foreground specification from the properties.

*/

clear_fullscreen()

C++ Interface: clear_fullscreen(const WindowProperties self)

/**

• Removes the fullscreen specification from the properties.

*/

clear_icon_filename()

C++ Interface: clear_icon_filename(const WindowProperties self)

/**

• Removes the icon_filename specification from the properties.

*/

clear_maximized()

C++ Interface: clear_maximized(const WindowProperties self)

/**

• Removes the maximized specification from the properties.

*/

clear_minimized()

C++ Interface: clear_minimized(const WindowProperties self)

/**

• Removes the minimized specification from the properties.

*/

clear_mouse_mode()

C++ Interface: clear_mouse_mode(const WindowProperties self)

/**

• Removes the mouse_mode specification from the properties.

*/

clear_open()

C++ Interface: clear_open(const WindowProperties self)

/**

• Removes the open specification from the properties.

*/

clear_origin()

C++ Interface: clear_origin(const WindowProperties self)

/**

• Removes the origin specification from the properties.

*/

clear_parent_window()

C++ Interface: clear_parent_window(const WindowProperties self)

/**

• Removes the S_parent_window specification from the properties.

*/

clear_raw_mice()

C++ Interface: clear_raw_mice(const WindowProperties self)

/**

• Removes the raw_mice specification from the properties.

*/

clear_size()

C++ Interface: clear_size(const WindowProperties self)

/**

• Removes the size specification from the properties.

*/

clear_title()

C++ Interface: clear_title(const WindowProperties self)

/**

• Removes the title specification from the properties.

*/

clear_undecorated()

C++ Interface: clear_undecorated(const WindowProperties self)

/**

• Removes the undecorated specification from the properties.

*/

clear_z_order()

C++ Interface: clear_z_order(const WindowProperties self)

/**

• Removes the z_order specification from the properties.

*/

config_properties = origin=(-2, -2) size=(800, 600) title="Panda" !undecorated !fixed_size !fullscreen !maximized open !cursor_hidden absolute

cursor_filename

cursor_hidden

default = origin=(-2, -2) size=(800, 600) title="Panda" !undecorated !fixed_size !fullscreen !maximized open !cursor_hidden absolute

fixed_size

foreground

fullscreen

getConfigProperties()

C++ Interface: get_config_properties()

/**

• Returns a WindowProperties structure with all of the default values filled

• in according to the user’s config file.

*/

getCursorFilename()

C++ Interface: get_cursor_filename(WindowProperties self)

/**

• Returns the icon filename associated with the mouse cursor.

*/

getCursorHidden()

C++ Interface: get_cursor_hidden(WindowProperties self)

/**

• Returns true if the mouse cursor is invisible.

*/

getDefault()

C++ Interface: get_default()

/**

• Returns the “default” WindowProperties. If set_default() has been called,

• this returns that WindowProperties structure; otherwise, this returns

• get_config_properties().

*/

getFixedSize()

C++ Interface: get_fixed_size(WindowProperties self)

/**

• Returns true if the window cannot be resized by the user, false otherwise.

*/

getForeground()

C++ Interface: get_foreground(WindowProperties self)

/**

• Returns true if the window is in the foreground.

*/

getFullscreen()

C++ Interface: get_fullscreen(WindowProperties self)

/**

• Returns true if the window is in fullscreen mode.

*/

getIconFilename()

C++ Interface: get_icon_filename(WindowProperties self)

/**

• Returns the icon filename associated with the window.

*/

getMaximized()

C++ Interface: get_maximized(WindowProperties self)

/**

• Returns true if the window is maximized.

*/

getMinimized()

C++ Interface: get_minimized(WindowProperties self)

/**

• Returns true if the window is minimized.

*/

getMouseMode()

C++ Interface: get_mouse_mode(WindowProperties self)

/**

• See set_mouse_mode().

*/

getOpen()

C++ Interface: get_open(WindowProperties self)

/**

• Returns true if the window is open.

*/

getOrigin()

C++ Interface: get_origin(WindowProperties self)

/**

• Returns the coordinates of the window’s top-left corner, not including

• decorations.

*/

getParentWindow()

C++ Interface: get_parent_window(WindowProperties self)

/**

• Returns the parent window specification, or NULL if there is no parent

• window specified.

*/

getRawMice()

C++ Interface: get_raw_mice(WindowProperties self)

/**

• Returns true if the window reads the raw mice.

*/

getSize()

C++ Interface: get_size(WindowProperties self)

/**

• Returns size in pixels of the useful part of the window, not including

• decorations.

*/

getTitle()

C++ Interface: get_title(WindowProperties self)

/**

• Returns the window’s title.

*/

getUndecorated()

C++ Interface: get_undecorated(WindowProperties self)

/**

• Returns true if the window has no border.

*/

getXOrigin()

C++ Interface: get_x_origin(WindowProperties self)

/**

• Returns the x coordinate of the window’s top-left corner, not including

• decorations.

*/

getXSize()

C++ Interface: get_x_size(WindowProperties self)

/**

• Returns size in pixels in the x dimension of the useful part of the window,

• not including decorations. That is, this is the window’s width.

*/

getYOrigin()

C++ Interface: get_y_origin(WindowProperties self)

/**

• Returns the y coordinate of the window’s top-left corner, not including

• decorations.

*/

getYSize()

C++ Interface: get_y_size(WindowProperties self)

/**

• Returns size in pixels in the y dimension of the useful part of the window,

• not including decorations. That is, this is the window’s height.

*/

getZOrder()

C++ Interface: get_z_order(WindowProperties self)

/**

• Returns the window’s z_order.

*/

get_config_properties()

C++ Interface: get_config_properties()

/**

• Returns a WindowProperties structure with all of the default values filled

• in according to the user’s config file.

*/

get_cursor_filename()

C++ Interface: get_cursor_filename(WindowProperties self)

/**

• Returns the icon filename associated with the mouse cursor.

*/

get_cursor_hidden()

C++ Interface: get_cursor_hidden(WindowProperties self)

/**

• Returns true if the mouse cursor is invisible.

*/

get_default()

C++ Interface: get_default()

/**

• Returns the “default” WindowProperties. If set_default() has been called,

• this returns that WindowProperties structure; otherwise, this returns

• get_config_properties().

*/

get_fixed_size()

C++ Interface: get_fixed_size(WindowProperties self)

/**

• Returns true if the window cannot be resized by the user, false otherwise.

*/

get_foreground()

C++ Interface: get_foreground(WindowProperties self)

/**

• Returns true if the window is in the foreground.

*/

get_fullscreen()

C++ Interface: get_fullscreen(WindowProperties self)

/**

• Returns true if the window is in fullscreen mode.

*/

get_icon_filename()

C++ Interface: get_icon_filename(WindowProperties self)

/**

• Returns the icon filename associated with the window.

*/

get_maximized()

C++ Interface: get_maximized(WindowProperties self)

/**

• Returns true if the window is maximized.

*/

get_minimized()

C++ Interface: get_minimized(WindowProperties self)

/**

• Returns true if the window is minimized.

*/

get_mouse_mode()

C++ Interface: get_mouse_mode(WindowProperties self)

/**

• See set_mouse_mode().

*/

get_open()

C++ Interface: get_open(WindowProperties self)

/**

• Returns true if the window is open.

*/

get_origin()

C++ Interface: get_origin(WindowProperties self)

/**

• Returns the coordinates of the window’s top-left corner, not including

• decorations.

*/

get_parent_window()

C++ Interface: get_parent_window(WindowProperties self)

/**

• Returns the parent window specification, or NULL if there is no parent

• window specified.

*/

get_raw_mice()

C++ Interface: get_raw_mice(WindowProperties self)

/**

• Returns true if the window reads the raw mice.

*/

get_size()

C++ Interface: get_size(WindowProperties self)

/**

• Returns size in pixels of the useful part of the window, not including

• decorations.

*/

get_title()

C++ Interface: get_title(WindowProperties self)

/**

• Returns the window’s title.

*/

get_undecorated()

C++ Interface: get_undecorated(WindowProperties self)

/**

• Returns true if the window has no border.

*/

get_x_origin()

C++ Interface: get_x_origin(WindowProperties self)

/**

• Returns the x coordinate of the window’s top-left corner, not including

• decorations.

*/

get_x_size()

C++ Interface: get_x_size(WindowProperties self)

/**

• Returns size in pixels in the x dimension of the useful part of the window,

• not including decorations. That is, this is the window’s width.

*/

get_y_origin()

C++ Interface: get_y_origin(WindowProperties self)

/**

• Returns the y coordinate of the window’s top-left corner, not including

• decorations.

*/

get_y_size()

C++ Interface: get_y_size(WindowProperties self)

/**

• Returns size in pixels in the y dimension of the useful part of the window,

• not including decorations. That is, this is the window’s height.

*/

get_z_order()

C++ Interface: get_z_order(WindowProperties self)

/**

• Returns the window’s z_order.

*/

hasCursorFilename()

C++ Interface: has_cursor_filename(WindowProperties self)

/**

• Returns true if set_cursor_filename() has been specified.

*/

hasCursorHidden()

C++ Interface: has_cursor_hidden(WindowProperties self)

/**

• Returns true if set_cursor_hidden() has been specified.

*/

hasFixedSize()

C++ Interface: has_fixed_size(WindowProperties self)

/**

• Returns true if set_fixed_size() has been specified.

*/

hasForeground()

C++ Interface: has_foreground(WindowProperties self)

/**

• Returns true if set_foreground() has been specified.

*/

hasFullscreen()

C++ Interface: has_fullscreen(WindowProperties self)

/**

• Returns true if set_fullscreen() has been specified.

*/

hasIconFilename()

C++ Interface: has_icon_filename(WindowProperties self)

/**

• Returns true if set_icon_filename() has been specified.

*/

hasMaximized()

C++ Interface: has_maximized(WindowProperties self)

/**

• Returns true if set_maximized() has been specified.

*/

hasMinimized()

C++ Interface: has_minimized(WindowProperties self)

/**

• Returns true if set_minimized() has been specified.

*/

hasMouseMode()

C++ Interface: has_mouse_mode(WindowProperties self)

/**

*/

hasOpen()

C++ Interface: has_open(WindowProperties self)

/**

• Returns true if set_open() has been specified.

*/

hasOrigin()

C++ Interface: has_origin(WindowProperties self)

/**

• Returns true if the window origin has been specified, false otherwise.

*/

hasParentWindow()

C++ Interface: has_parent_window(WindowProperties self)

/**

• Checks the S_parent_window specification from the properties.

*/

hasRawMice()

C++ Interface: has_raw_mice(WindowProperties self)

/**

• Returns true if set_raw_mice() has been specified.

*/

hasSize()

C++ Interface: has_size(WindowProperties self)

/**

• Returns true if the window size has been specified, false otherwise.

*/

hasTitle()

C++ Interface: has_title(WindowProperties self)

/**

• Returns true if the window title has been specified, false otherwise.

*/

hasUndecorated()

C++ Interface: has_undecorated(WindowProperties self)

/**

• Returns true if set_undecorated() has been specified.

*/

hasZOrder()

C++ Interface: has_z_order(WindowProperties self)

/**

• Returns true if the window z_order has been specified, false otherwise.

*/

has_cursor_filename()

C++ Interface: has_cursor_filename(WindowProperties self)

/**

• Returns true if set_cursor_filename() has been specified.

*/

has_cursor_hidden()

C++ Interface: has_cursor_hidden(WindowProperties self)

/**

• Returns true if set_cursor_hidden() has been specified.

*/

has_fixed_size()

C++ Interface: has_fixed_size(WindowProperties self)

/**

• Returns true if set_fixed_size() has been specified.

*/

has_foreground()

C++ Interface: has_foreground(WindowProperties self)

/**

• Returns true if set_foreground() has been specified.

*/

has_fullscreen()

C++ Interface: has_fullscreen(WindowProperties self)

/**

• Returns true if set_fullscreen() has been specified.

*/

has_icon_filename()

C++ Interface: has_icon_filename(WindowProperties self)

/**

• Returns true if set_icon_filename() has been specified.

*/

has_maximized()

C++ Interface: has_maximized(WindowProperties self)

/**

• Returns true if set_maximized() has been specified.

*/

has_minimized()

C++ Interface: has_minimized(WindowProperties self)

/**

• Returns true if set_minimized() has been specified.

*/

has_mouse_mode()

C++ Interface: has_mouse_mode(WindowProperties self)

/**

*/

has_open()

C++ Interface: has_open(WindowProperties self)

/**

• Returns true if set_open() has been specified.

*/

has_origin()

C++ Interface: has_origin(WindowProperties self)

/**

• Returns true if the window origin has been specified, false otherwise.

*/

has_parent_window()

C++ Interface: has_parent_window(WindowProperties self)

/**

• Checks the S_parent_window specification from the properties.

*/

has_raw_mice()

C++ Interface: has_raw_mice(WindowProperties self)

/**

• Returns true if set_raw_mice() has been specified.

*/

has_size()

C++ Interface: has_size(WindowProperties self)

/**

• Returns true if the window size has been specified, false otherwise.

*/

has_title()

C++ Interface: has_title(WindowProperties self)

/**

• Returns true if the window title has been specified, false otherwise.

*/

has_undecorated()

C++ Interface: has_undecorated(WindowProperties self)

/**

• Returns true if set_undecorated() has been specified.

*/

has_z_order()

C++ Interface: has_z_order(WindowProperties self)

/**

• Returns true if the window z_order has been specified, false otherwise.

*/

icon_filename

isAnySpecified()

C++ Interface: is_any_specified(WindowProperties self)

/**

• Returns true if any properties have been specified, false otherwise.

*/

is_any_specified()

C++ Interface: is_any_specified(WindowProperties self)

/**

• Returns true if any properties have been specified, false otherwise.

*/

maximized

minimized

mouse_mode

open

origin

output()

C++ Interface: output(WindowProperties self, ostream out)

/**

• Sets any properties that are explicitly specified in other on this object.

• Leaves other properties unchanged.

*/

parent_window

setCursorFilename()

C++ Interface: set_cursor_filename(const WindowProperties self, const Filename cursor_filename)

/**

• Specifies the file that contains the icon to associate with the mouse

• cursor when it is within the window (and visible).

*/

setCursorHidden()

C++ Interface: set_cursor_hidden(const WindowProperties self, bool cursor_hidden)

/**

• Specifies whether the mouse cursor should be visible.

*/

setDefault()

C++ Interface: set_default(const WindowProperties default_properties)

/**

• Replaces the “default” WindowProperties with the specified structure. The

• specified WindowProperties will be returned by future calls to

• get_default(), until clear_default() is called.

• Note that this completely replaces the default properties; it is not

• additive.

*/

setFixedSize()

C++ Interface: set_fixed_size(const WindowProperties self, bool fixed_size)

/**

• Specifies whether the window should be resizable by the user.

*/

setForeground()

C++ Interface: set_foreground(const WindowProperties self, bool foreground)

/**

• Specifies whether the window should be opened in the foreground (true), or

• left in the background (false).

*/

setFullscreen()

C++ Interface: set_fullscreen(const WindowProperties self, bool fullscreen)

/**

• Specifies whether the window should be opened in fullscreen mode (true) or

• normal windowed mode (false, the default).

*/

setIconFilename()

C++ Interface: set_icon_filename(const WindowProperties self, const Filename icon_filename)

/**

• Specifies the file that contains the icon to associate with the window when

• it is minimized.

*/

setMaximized()

C++ Interface: set_maximized(const WindowProperties self, bool maximized)

/**

• Specifies whether the window should be created maximized (true), or normal

• (false).

*/

setMinimized()

C++ Interface: set_minimized(const WindowProperties self, bool minimized)

/**

• Specifies whether the window should be created minimized (true), or normal

• (false).

*/

setMouseMode()

C++ Interface: set_mouse_mode(const WindowProperties self, int mode)

/**

• Specifies the mode in which the window is to operate its mouse pointer.

• M_absolute: the normal mode in which a mouse pointer operates, where the

• mouse can move outside the window and the mouse coordinates are relative to

• its position in the window.

• M_confined: this mode reports absolute mouse positions, but confines the

• mouse pointer to the window boundary. The reported mouse positions will

• never be outside of the window boundary.

• M_relative: a mode where only relative movements are reported; particularly

• useful for FPS-style mouse movements where you have hidden the mouse

• pointer and are are more interested in how fast the mouse is moving, rather

• than precisely where the pointer is hovering. The reported positions still

• appear to be absolute, but they can go toward negative or positive infinity

• without being constrained by the window (or screen) dimensions. Since the

• position of the mouse cursor becomes meaningless in this mode, it is

• recommended to combine this with the cursor_hidden flag.

*/

setOpen()

C++ Interface: set_open(const WindowProperties self, bool open)

/**

• Specifies whether the window should be open. It is legal to create a

• GraphicsWindow in the closed state, and later request it to open by

• changing this flag.

*/

setOrigin()

C++ Interface: set_origin(const WindowProperties self, const LPoint2i origin) set_origin(const WindowProperties self, int x_origin, int y_origin)

/**

• Specifies the origin on the screen (in pixels, relative to the top-left

• corner) at which the window should appear. This is the origin of the top-

• left corner of the useful part of the window, not including decorations.

*/

/**

• Specifies the origin on the screen (in pixels, relative to the top-left

• corner) at which the window should appear. This is the origin of the top-

• left corner of the useful part of the window, not including decorations.

*/

setParentWindow()

C++ Interface: set_parent_window(const WindowProperties self) set_parent_window(const WindowProperties self, WindowHandle parent_window) set_parent_window(const WindowProperties self, int parent)

/**

• Specifies the window that this window should be attached to. If this is

• NULL or unspecified, the window will be created as a toplevel window on the

• desktop; if this is non-NULL, the window will be bound as a child window to

• the indicated parent window.

• You should use GraphicsPipe::make_window_handle() to create an instance of

• a WindowHandle object given an appropriate OS-specific window handle

• representation. Each OS-specific GraphicsPipe class defines a

• make_window_handle() method that returns an appropriate WindowHandle object

• to wrap the particular OS-specific representation.

*/

/**

• Specifies the window that this window should be attached to.

• This is a deprecated variant on this method, and exists only for backward

• compatibility. Future code should use the version of set_parent_window()

• below that receives a WindowHandle object; that interface is much more

• robust.

• In this deprecated variant, the actual value for “parent” is platform-

• specific. On Windows, it is the HWND of the parent window, cast to an

• unsigned integer. On X11, it is the Window pointer of the parent window,

• similarly cast. On OSX, this is the NSWindow pointer, which doesn’t appear

• to work at all.

*/

setRawMice()

C++ Interface: set_raw_mice(const WindowProperties self, bool raw_mice)

/**

• Specifies whether the window should read the raw mouse devices.

*/

setSize()

C++ Interface: set_size(const WindowProperties self, const LVector2i size) set_size(const WindowProperties self, int x_size, int y_size)

/**

• Specifies the requested size of the window, in pixels. This is the size of

• the useful part of the window, not including decorations.

*/

/**

• Specifies the requested size of the window, in pixels. This is the size of

• the useful part of the window, not including decorations.

*/

setTitle()

C++ Interface: set_title(const WindowProperties self, str title)

/**

• Specifies the title that should be assigned to the window.

*/

setUndecorated()

C++ Interface: set_undecorated(const WindowProperties self, bool undecorated)

/**

• Specifies whether the window should be created with a visible title and

• border (false, the default) or not (true).

*/

setZOrder()

C++ Interface: set_z_order(const WindowProperties self, int z_order)

/**

• Specifies the relative ordering of the window with respect to other

• windows. If the z_order is Z_top, the window will always be on top of

• other windows; if it is Z_bottom, it will always be below other windows.

• Most windows will want to be Z_normal, which allows the user to control the

• order.

*/

set_cursor_filename()

C++ Interface: set_cursor_filename(const WindowProperties self, const Filename cursor_filename)

/**

• Specifies the file that contains the icon to associate with the mouse

• cursor when it is within the window (and visible).

*/

set_cursor_hidden()

C++ Interface: set_cursor_hidden(const WindowProperties self, bool cursor_hidden)

/**

• Specifies whether the mouse cursor should be visible.

*/

set_default()

C++ Interface: set_default(const WindowProperties default_properties)

/**

• Replaces the “default” WindowProperties with the specified structure. The

• specified WindowProperties will be returned by future calls to

• get_default(), until clear_default() is called.

• Note that this completely replaces the default properties; it is not

• additive.

*/

set_fixed_size()

C++ Interface: set_fixed_size(const WindowProperties self, bool fixed_size)

/**

• Specifies whether the window should be resizable by the user.

*/

set_foreground()

C++ Interface: set_foreground(const WindowProperties self, bool foreground)

/**

• Specifies whether the window should be opened in the foreground (true), or

• left in the background (false).

*/

set_fullscreen()

C++ Interface: set_fullscreen(const WindowProperties self, bool fullscreen)

/**

• Specifies whether the window should be opened in fullscreen mode (true) or

• normal windowed mode (false, the default).

*/

set_icon_filename()

C++ Interface: set_icon_filename(const WindowProperties self, const Filename icon_filename)

/**

• Specifies the file that contains the icon to associate with the window when

• it is minimized.

*/

set_maximized()

C++ Interface: set_maximized(const WindowProperties self, bool maximized)

/**

• Specifies whether the window should be created maximized (true), or normal

• (false).

*/

set_minimized()

C++ Interface: set_minimized(const WindowProperties self, bool minimized)

/**

• Specifies whether the window should be created minimized (true), or normal

• (false).

*/

set_mouse_mode()

C++ Interface: set_mouse_mode(const WindowProperties self, int mode)

/**

• Specifies the mode in which the window is to operate its mouse pointer.

• M_absolute: the normal mode in which a mouse pointer operates, where the

• mouse can move outside the window and the mouse coordinates are relative to

• its position in the window.

• M_confined: this mode reports absolute mouse positions, but confines the

• mouse pointer to the window boundary. The reported mouse positions will

• never be outside of the window boundary.

• M_relative: a mode where only relative movements are reported; particularly

• useful for FPS-style mouse movements where you have hidden the mouse

• pointer and are are more interested in how fast the mouse is moving, rather

• than precisely where the pointer is hovering. The reported positions still

• appear to be absolute, but they can go toward negative or positive infinity

• without being constrained by the window (or screen) dimensions. Since the

• position of the mouse cursor becomes meaningless in this mode, it is

• recommended to combine this with the cursor_hidden flag.

*/

set_open()

C++ Interface: set_open(const WindowProperties self, bool open)

/**

• Specifies whether the window should be open. It is legal to create a

• GraphicsWindow in the closed state, and later request it to open by

• changing this flag.

*/

set_origin()

C++ Interface: set_origin(const WindowProperties self, const LPoint2i origin) set_origin(const WindowProperties self, int x_origin, int y_origin)

/**

• Specifies the origin on the screen (in pixels, relative to the top-left

• corner) at which the window should appear. This is the origin of the top-

• left corner of the useful part of the window, not including decorations.

*/

/**

• Specifies the origin on the screen (in pixels, relative to the top-left

• corner) at which the window should appear. This is the origin of the top-

• left corner of the useful part of the window, not including decorations.

*/

set_parent_window()

C++ Interface: set_parent_window(const WindowProperties self) set_parent_window(const WindowProperties self, WindowHandle parent_window) set_parent_window(const WindowProperties self, int parent)

/**

• Specifies the window that this window should be attached to. If this is

• NULL or unspecified, the window will be created as a toplevel window on the

• desktop; if this is non-NULL, the window will be bound as a child window to

• the indicated parent window.

• You should use GraphicsPipe::make_window_handle() to create an instance of

• a WindowHandle object given an appropriate OS-specific window handle

• representation. Each OS-specific GraphicsPipe class defines a

• make_window_handle() method that returns an appropriate WindowHandle object

• to wrap the particular OS-specific representation.

*/

/**

• Specifies the window that this window should be attached to.

• This is a deprecated variant on this method, and exists only for backward

• compatibility. Future code should use the version of set_parent_window()

• below that receives a WindowHandle object; that interface is much more

• robust.

• In this deprecated variant, the actual value for “parent” is platform-

• specific. On Windows, it is the HWND of the parent window, cast to an

• unsigned integer. On X11, it is the Window pointer of the parent window,

• similarly cast. On OSX, this is the NSWindow pointer, which doesn’t appear

• to work at all.

*/

set_raw_mice()

C++ Interface: set_raw_mice(const WindowProperties self, bool raw_mice)

/**

• Specifies whether the window should read the raw mouse devices.

*/

set_size()

C++ Interface: set_size(const WindowProperties self, const LVector2i size) set_size(const WindowProperties self, int x_size, int y_size)

/**

• Specifies the requested size of the window, in pixels. This is the size of

• the useful part of the window, not including decorations.

*/

/**

• Specifies the requested size of the window, in pixels. This is the size of

• the useful part of the window, not including decorations.

*/

set_title()

C++ Interface: set_title(const WindowProperties self, str title)

/**

• Specifies the title that should be assigned to the window.

*/

set_undecorated()

C++ Interface: set_undecorated(const WindowProperties self, bool undecorated)

/**

• Specifies whether the window should be created with a visible title and

• border (false, the default) or not (true).

*/

set_z_order()

C++ Interface: set_z_order(const WindowProperties self, int z_order)

/**

• Specifies the relative ordering of the window with respect to other

• windows. If the z_order is Z_top, the window will always be on top of

• other windows; if it is Z_bottom, it will always be below other windows.

• Most windows will want to be Z_normal, which allows the user to control the

• order.

*/

size()

C++ Interface: size(const LVecBase2i size) size(int x_size, int y_size)

/**

• Returns a WindowProperties structure with only the size specified. The

• size is the only property that matters to buffers.

• @deprecated in the Python API, use WindowProperties(size=(x, y)) instead.

*/

title

undecorated

z_order