var searchIndex = {};
searchIndex["winit"] = {"doc":"The purpose of this library is to provide an OpenGL context on as many\n platforms as possible.","items":[[3,"Touch","winit","Represents touch event",null,null],[12,"phase","","",0,null],[12,"location","","",0,null],[12,"id","","unique identifier of a finger.",0,null],[3,"WindowBuilder","","Object that allows you to build windows.",null,null],[12,"window","","The attributes to use to create the window.",1,null],[3,"WindowProxy","","Represents a thread safe subset of operations that can be called\non a window. This structure can be safely cloned and sent between\nthreads.",null,null],[3,"PollEventsIterator","","An iterator for the `poll_events` function.",null,null],[3,"WaitEventsIterator","","An iterator for the `wait_events` function.",null,null],[3,"AvailableMonitorsIter","","An iterator for the list of available monitors.",null,null],[3,"MonitorId","","Identifier for a monitor.",null,null],[3,"Window","","Represents an OpenGL context and the Window or environment around it.",null,null],[3,"WindowAttributes","","Attributes to use when creating a window.",null,null],[12,"dimensions","","The dimensions of the window. If this is `None`, some platform-specific dimensions will be\nused.",2,null],[12,"min_dimensions","","The minimum dimensions a window can be, If this is `None`, the window will have no minimum dimensions (aside from reserved).",2,null],[12,"max_dimensions","","The maximum dimensions a window can be, If this is `None`, the maximum will have no maximum or will be set to the primary monitor's dimensions by the platform.",2,null],[12,"monitor","","If `Some`, the window will be in fullscreen mode with the given monitor.",2,null],[12,"title","","The title of the window in the title bar.",2,null],[12,"visible","","Whether the window should be immediately visible upon creation.",2,null],[12,"transparent","","Whether the the window should be transparent. If this is true, writing colors\nwith alpha values different than `1.0` will produce a transparent window.",2,null],[12,"decorations","","Whether the window should have borders and bars.",2,null],[12,"multitouch","","[iOS only] Enable multitouch, see [UIView#multipleTouchEnabled]\n(https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIView_Class/#//apple_ref/occ/instp/UIView/multipleTouchEnabled)",2,null],[4,"Event","","",null,null],[13,"Resized","","The size of the window has changed.",3,null],[13,"Moved","","The position of the window has changed.",3,null],[13,"Closed","","The window has been closed.",3,null],[13,"DroppedFile","","A file has been dropped into the window.",3,null],[13,"ReceivedCharacter","","The window received a unicode character.",3,null],[13,"Focused","","The window gained or lost focus.",3,null],[13,"KeyboardInput","","An event from the keyboard has been received.",3,null],[13,"MouseMoved","","The cursor has moved on the window.",3,null],[13,"MouseWheel","","A mouse wheel movement or touchpad scroll occurred.",3,null],[13,"MouseInput","","An event from the mouse has been received.",3,null],[13,"TouchpadPressure","","Touchpad pressure event.",3,null],[13,"Awakened","","The event loop was woken up by another thread.",3,null],[13,"Refresh","","The window needs to be redrawn.",3,null],[13,"Suspended","","App has been suspended or resumed.",3,null],[13,"Touch","","Touch event has been received",3,null],[4,"TouchPhase","","",null,null],[13,"Started","","",4,null],[13,"Moved","","",4,null],[13,"Ended","","",4,null],[13,"Cancelled","","",4,null],[4,"ElementState","","",null,null],[13,"Pressed","","",5,null],[13,"Released","","",5,null],[4,"MouseButton","","",null,null],[13,"Left","","",6,null],[13,"Right","","",6,null],[13,"Middle","","",6,null],[13,"Other","","",6,null],[4,"MouseScrollDelta","","",null,null],[13,"LineDelta","","Amount in lines or rows to scroll in the horizontal\nand vertical directions.",7,null],[13,"PixelDelta","","Amount in pixels to scroll in the horizontal and\nvertical direction.",7,null],[4,"VirtualKeyCode","","",null,null],[13,"Key1","","The '1' key over the letters.",8,null],[13,"Key2","","The '2' key over the letters.",8,null],[13,"Key3","","The '3' key over the letters.",8,null],[13,"Key4","","The '4' key over the letters.",8,null],[13,"Key5","","The '5' key over the letters.",8,null],[13,"Key6","","The '6' key over the letters.",8,null],[13,"Key7","","The '7' key over the letters.",8,null],[13,"Key8","","The '8' key over the letters.",8,null],[13,"Key9","","The '9' key over the letters.",8,null],[13,"Key0","","The '0' key over the 'O' and 'P' keys.",8,null],[13,"A","","",8,null],[13,"B","","",8,null],[13,"C","","",8,null],[13,"D","","",8,null],[13,"E","","",8,null],[13,"F","","",8,null],[13,"G","","",8,null],[13,"H","","",8,null],[13,"I","","",8,null],[13,"J","","",8,null],[13,"K","","",8,null],[13,"L","","",8,null],[13,"M","","",8,null],[13,"N","","",8,null],[13,"O","","",8,null],[13,"P","","",8,null],[13,"Q","","",8,null],[13,"R","","",8,null],[13,"S","","",8,null],[13,"T","","",8,null],[13,"U","","",8,null],[13,"V","","",8,null],[13,"W","","",8,null],[13,"X","","",8,null],[13,"Y","","",8,null],[13,"Z","","",8,null],[13,"Escape","","The Escape key, next to F1.",8,null],[13,"F1","","",8,null],[13,"F2","","",8,null],[13,"F3","","",8,null],[13,"F4","","",8,null],[13,"F5","","",8,null],[13,"F6","","",8,null],[13,"F7","","",8,null],[13,"F8","","",8,null],[13,"F9","","",8,null],[13,"F10","","",8,null],[13,"F11","","",8,null],[13,"F12","","",8,null],[13,"F13","","",8,null],[13,"F14","","",8,null],[13,"F15","","",8,null],[13,"Snapshot","","Print Screen/SysRq.",8,null],[13,"Scroll","","Scroll Lock.",8,null],[13,"Pause","","Pause/Break key, next to Scroll lock.",8,null],[13,"Insert","","`Insert`, next to Backspace.",8,null],[13,"Home","","",8,null],[13,"Delete","","",8,null],[13,"End","","",8,null],[13,"PageDown","","",8,null],[13,"PageUp","","",8,null],[13,"Left","","",8,null],[13,"Up","","",8,null],[13,"Right","","",8,null],[13,"Down","","",8,null],[13,"Back","","The Backspace key, right over Enter.",8,null],[13,"Return","","The Enter key.",8,null],[13,"Space","","The space bar.",8,null],[13,"Numlock","","",8,null],[13,"Numpad0","","",8,null],[13,"Numpad1","","",8,null],[13,"Numpad2","","",8,null],[13,"Numpad3","","",8,null],[13,"Numpad4","","",8,null],[13,"Numpad5","","",8,null],[13,"Numpad6","","",8,null],[13,"Numpad7","","",8,null],[13,"Numpad8","","",8,null],[13,"Numpad9","","",8,null],[13,"AbntC1","","",8,null],[13,"AbntC2","","",8,null],[13,"Add","","",8,null],[13,"Apostrophe","","",8,null],[13,"Apps","","",8,null],[13,"At","","",8,null],[13,"Ax","","",8,null],[13,"Backslash","","",8,null],[13,"Calculator","","",8,null],[13,"Capital","","",8,null],[13,"Colon","","",8,null],[13,"Comma","","",8,null],[13,"Convert","","",8,null],[13,"Decimal","","",8,null],[13,"Divide","","",8,null],[13,"Equals","","",8,null],[13,"Grave","","",8,null],[13,"Kana","","",8,null],[13,"Kanji","","",8,null],[13,"LAlt","","",8,null],[13,"LBracket","","",8,null],[13,"LControl","","",8,null],[13,"LMenu","","",8,null],[13,"LShift","","",8,null],[13,"LWin","","",8,null],[13,"Mail","","",8,null],[13,"MediaSelect","","",8,null],[13,"MediaStop","","",8,null],[13,"Minus","","",8,null],[13,"Multiply","","",8,null],[13,"Mute","","",8,null],[13,"MyComputer","","",8,null],[13,"NavigateForward","","",8,null],[13,"NavigateBackward","","",8,null],[13,"NextTrack","","",8,null],[13,"NoConvert","","",8,null],[13,"NumpadComma","","",8,null],[13,"NumpadEnter","","",8,null],[13,"NumpadEquals","","",8,null],[13,"OEM102","","",8,null],[13,"Period","","",8,null],[13,"PlayPause","","",8,null],[13,"Power","","",8,null],[13,"PrevTrack","","",8,null],[13,"RAlt","","",8,null],[13,"RBracket","","",8,null],[13,"RControl","","",8,null],[13,"RMenu","","",8,null],[13,"RShift","","",8,null],[13,"RWin","","",8,null],[13,"Semicolon","","",8,null],[13,"Slash","","",8,null],[13,"Sleep","","",8,null],[13,"Stop","","",8,null],[13,"Subtract","","",8,null],[13,"Sysrq","","",8,null],[13,"Tab","","",8,null],[13,"Underline","","",8,null],[13,"Unlabeled","","",8,null],[13,"VolumeDown","","",8,null],[13,"VolumeUp","","",8,null],[13,"Wake","","",8,null],[13,"WebBack","","",8,null],[13,"WebFavorites","","",8,null],[13,"WebForward","","",8,null],[13,"WebHome","","",8,null],[13,"WebRefresh","","",8,null],[13,"WebSearch","","",8,null],[13,"WebStop","","",8,null],[13,"Yen","","",8,null],[4,"NativeMonitorId","","Native platform identifier for a monitor. Different platforms use fundamentally different types\nto represent a monitor ID.",null,null],[13,"Numeric","","Cocoa and X11 use a numeric identifier to represent a monitor.",9,null],[13,"Name","","Win32 uses a Unicode string to represent a monitor.",9,null],[13,"Unavailable","","Other platforms (Android) don't support monitor identification.",9,null],[4,"CreationError","","Error that can happen while creating a window or a headless renderer.",null,null],[13,"OsError","","",10,null],[13,"NotSupported","","TODO: remove this error",10,null],[4,"MouseCursor","","",null,null],[13,"Default","","The platform-dependent default cursor.",11,null],[13,"Crosshair","","A simple crosshair.",11,null],[13,"Hand","","A hand (often used to indicate links in web browsers).",11,null],[13,"Arrow","","Self explanatory.",11,null],[13,"Move","","Indicates something is to be moved.",11,null],[13,"Text","","Indicates text that may be selected or edited.",11,null],[13,"Wait","","Program busy indicator.",11,null],[13,"Help","","Help indicator (often rendered as a "?")",11,null],[13,"Progress","","Progress indicator. Shows that processing is being done. But in contrast\nwith "Wait" the user may still interact with the program. Often rendered\nas a spinning beach ball, or an arrow with a watch or hourglass.",11,null],[13,"NotAllowed","","Cursor showing that something cannot be done.",11,null],[13,"ContextMenu","","",11,null],[13,"NoneCursor","","",11,null],[13,"Cell","","",11,null],[13,"VerticalText","","",11,null],[13,"Alias","","",11,null],[13,"Copy","","",11,null],[13,"NoDrop","","",11,null],[13,"Grab","","",11,null],[13,"Grabbing","","",11,null],[13,"AllScroll","","",11,null],[13,"ZoomIn","","",11,null],[13,"ZoomOut","","",11,null],[13,"EResize","","Indicate that some edge is to be moved. For example, the 'SeResize' cursor\nis used when the movement starts from the south-east corner of the box.",11,null],[13,"NResize","","",11,null],[13,"NeResize","","",11,null],[13,"NwResize","","",11,null],[13,"SResize","","",11,null],[13,"SeResize","","",11,null],[13,"SwResize","","",11,null],[13,"WResize","","",11,null],[13,"EwResize","","",11,null],[13,"NsResize","","",11,null],[13,"NeswResize","","",11,null],[13,"NwseResize","","",11,null],[13,"ColResize","","",11,null],[13,"RowResize","","",11,null],[4,"CursorState","","Describes how glutin handles the cursor.",null,null],[13,"Normal","","Normal cursor behavior.",12,null],[13,"Hide","","The cursor will be invisible when over the window.",12,null],[13,"Grab","","Grabs the mouse cursor. The cursor's motion will be confined to this\nwindow and the window has exclusive access to further events regarding\nthe cursor.",12,null],[5,"get_available_monitors","","Returns the list of all available monitors.",null,{"inputs":[],"output":{"name":"availablemonitorsiter"}}],[5,"get_primary_monitor","","Returns the primary monitor of the system.",null,{"inputs":[],"output":{"name":"monitorid"}}],[11,"fmt","","",3,null],[11,"clone","","",3,null],[11,"clone","","",4,null],[11,"eq","","",4,null],[11,"hash","","",4,null],[11,"fmt","","",4,null],[11,"clone","","",0,null],[11,"fmt","","",0,null],[11,"clone","","",5,null],[11,"eq","","",5,null],[11,"hash","","",5,null],[11,"fmt","","",5,null],[11,"clone","","",6,null],[11,"eq","","",6,null],[11,"ne","","",6,null],[11,"hash","","",6,null],[11,"fmt","","",6,null],[11,"eq","","",7,null],[11,"ne","","",7,null],[11,"clone","","",7,null],[11,"fmt","","",7,null],[11,"clone","","",8,null],[11,"eq","","",8,null],[11,"hash","","",8,null],[11,"fmt","","",8,null],[11,"new","","Initializes a new `WindowBuilder` with default values.",1,{"inputs":[],"output":{"name":"windowbuilder"}}],[11,"with_dimensions","","Requests the window to be of specific dimensions.",1,null],[11,"with_min_dimensions","","Sets a minimum dimension size for the window",1,null],[11,"with_max_dimensions","","Sets a maximum dimension size for the window",1,null],[11,"with_title","","Requests a specific title for the window.",1,null],[11,"with_fullscreen","","Requests fullscreen mode.",1,null],[11,"with_visibility","","Sets whether the window will be initially hidden or visible.",1,null],[11,"with_transparency","","Sets whether the background of the window should be transparent.",1,null],[11,"with_decorations","","Sets whether the window should have a border, a title bar, etc.",1,null],[11,"with_multitouch","","Enables multitouch",1,null],[11,"build","","Builds the window.",1,null],[11,"build_strict","","Builds the window.",1,null],[11,"default","","",13,{"inputs":[],"output":{"name":"window"}}],[11,"new","","Creates a new OpenGL context, and a Window for platforms where this is appropriate.",13,{"inputs":[],"output":{"name":"result"}}],[11,"set_title","","Modifies the title of the window.",13,null],[11,"show","","Shows the window if it was hidden.",13,null],[11,"hide","","Hides the window if it was visible.",13,null],[11,"get_position","","Returns the position of the top-left hand corner of the window relative to the\n top-left hand corner of the desktop.",13,null],[11,"set_position","","Modifies the position of the window.",13,null],[11,"get_inner_size","","Returns the size in points of the client area of the window.",13,null],[11,"get_inner_size_points","","Returns the size in points of the client area of the window.",13,null],[11,"get_inner_size_pixels","","Returns the size in pixels of the client area of the window.",13,null],[11,"get_outer_size","","Returns the size in pixels of the window.",13,null],[11,"set_inner_size","","Modifies the inner size of the window.",13,null],[11,"poll_events","","Returns an iterator that poll for the next event in the window's events queue.\nReturns `None` if there is no event in the queue.",13,null],[11,"wait_events","","Returns an iterator that returns events one by one, blocking if necessary until one is\navailable.",13,null],[11,"platform_display","","DEPRECATED. Gets the native platform specific display for this window.\nThis is typically only required when integrating with\nother libraries that need this information.",13,null],[11,"platform_window","","DEPRECATED. Gets the native platform specific window handle. This is\ntypically only required when integrating with other libraries\nthat need this information.",13,null],[11,"create_window_proxy","","Create a window proxy for this window, that can be freely\npassed to different threads.",13,null],[11,"set_window_resize_callback","","Sets a resize callback that is called by Mac (and potentially other\noperating systems) during resize operations. This can be used to repaint\nduring window resizing.",13,null],[11,"set_cursor","","Modifies the mouse cursor of the window.\nHas no effect on Android.",13,null],[11,"hidpi_factor","","Returns the ratio between the backing framebuffer resolution and the\nwindow size in screen pixels. This is typically one for a normal display\nand two for a retina display.",13,null],[11,"set_cursor_position","","Changes the position of the cursor in window coordinates.",13,null],[11,"set_cursor_state","","Sets how glutin handles the cursor. See the documentation of `CursorState` for details.",13,null],[11,"clone","","",14,null],[11,"wakeup_event_loop","","Triggers a blocked event loop to wake up. This is\ntypically called when another thread wants to wake\nup the blocked rendering thread to cause a refresh.",14,null],[11,"next","","",15,null],[11,"size_hint","","",15,null],[11,"next","","",16,null],[11,"size_hint","","",16,null],[11,"next","","",17,null],[11,"size_hint","","",17,null],[11,"get_name","","Returns a human-readable name of the monitor.",18,null],[11,"get_native_identifier","","Returns the native platform identifier for this monitor.",18,null],[11,"get_dimensions","","Returns the number of pixels currently displayed on the monitor.",18,null],[0,"os","","Contains traits with platform-specific methods in them.",null,null],[0,"unix","winit::os","",null,null],[8,"WindowExt","winit::os::unix","Additional methods on `Window` that are specific to Unix.",null,null],[10,"get_xlib_window","","Returns a pointer to the `Window` object of xlib that is used by this window.",19,null],[10,"get_xlib_display","","Returns a pointer to the `Display` object of xlib that is used by this window.",19,null],[8,"WindowBuilderExt","","Additional methods on `WindowBuilder` that are specific to Unix.",null,null],[11,"get_xlib_window","winit","",13,null],[11,"get_xlib_display","","",13,null],[11,"eq","","",9,null],[11,"ne","","",9,null],[11,"clone","","",9,null],[6,"ScanCode","","",null,null],[11,"fmt","","",10,null],[11,"fmt","","",10,null],[11,"description","","",10,null],[11,"clone","","",11,null],[11,"fmt","","",11,null],[11,"clone","","",12,null],[11,"fmt","","",12,null],[11,"clone","","",2,null],[11,"default","","",2,{"inputs":[],"output":{"name":"windowattributes"}}]],"paths":[[3,"Touch"],[3,"WindowBuilder"],[3,"WindowAttributes"],[4,"Event"],[4,"TouchPhase"],[4,"ElementState"],[4,"MouseButton"],[4,"MouseScrollDelta"],[4,"VirtualKeyCode"],[4,"NativeMonitorId"],[4,"CreationError"],[4,"MouseCursor"],[4,"CursorState"],[3,"Window"],[3,"WindowProxy"],[3,"PollEventsIterator"],[3,"WaitEventsIterator"],[3,"AvailableMonitorsIter"],[3,"MonitorId"],[8,"WindowExt"]]};
initSearch(searchIndex);