mirror of
https://github.com/encounter/rust-sdl2.git
synced 2026-07-10 21:18:41 -07:00
34 lines
5.9 KiB
HTML
34 lines
5.9 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `SDL_CreateWindow` fn in crate `sdl2_sys`."><meta name="keywords" content="rust, rustlang, rust-lang, SDL_CreateWindow"><title>sdl2_sys::SDL_CreateWindow - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../sdl2_sys/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>sdl2_sys</a></p><script>window.sidebarCurrent = {name: 'SDL_CreateWindow', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/sdl2_sys/Users/travis/build/Rust-SDL2/rust-sdl2/target/debug/build/sdl2-sys-f32779682524d647/out/sdl_bindings.rs.html#7756-7763' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>sdl2_sys</a>::<wbr><a class="fn" href=''>SDL_CreateWindow</a></span></h1><pre class='rust fn'>pub unsafe extern "C" fn SDL_CreateWindow(<br> title: *const <a class="type" href="../libc/unix/bsd/apple/type.c_char.html" title="type libc::unix::bsd::apple::c_char">c_char</a>, <br> x: <a class="type" href="../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>, <br> y: <a class="type" href="../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>, <br> w: <a class="type" href="../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>, <br> h: <a class="type" href="../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>, <br> flags: <a class="type" href="../sdl2_sys/type.Uint32.html" title="type sdl2_sys::Uint32">Uint32</a><br>) -> *mut <a class="struct" href="../sdl2_sys/struct.SDL_Window.html" title="struct sdl2_sys::SDL_Window">SDL_Window</a></pre><div class='docblock'><p>\brief Create a window with the specified position, dimensions, and flags.</p>
|
||
<p>\param title The title of the window, in UTF-8 encoding.
|
||
\param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
|
||
::SDL_WINDOWPOS_UNDEFINED.
|
||
\param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
|
||
::SDL_WINDOWPOS_UNDEFINED.
|
||
\param w The width of the window, in screen coordinates.
|
||
\param h The height of the window, in screen coordinates.
|
||
\param flags The flags for the window, a mask of any of the following:
|
||
::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL,
|
||
::SDL_WINDOW_HIDDEN, ::SDL_WINDOW_BORDERLESS,
|
||
::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED,
|
||
::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_INPUT_GRABBED,
|
||
::SDL_WINDOW_ALLOW_HIGHDPI, ::SDL_WINDOW_VULKAN.</p>
|
||
<p>\return The created window, or NULL if window creation failed.</p>
|
||
<p>If the window is created with the SDL_WINDOW_ALLOW_HIGHDPI flag, its size
|
||
in pixels may differ from its size in screen coordinates on platforms with
|
||
high-DPI support (e.g. iOS and Mac OS X). Use SDL_GetWindowSize() to query
|
||
the client area's size in screen coordinates, and SDL_GL_GetDrawableSize(),
|
||
SDL_Vulkan_GetDrawableSize(), or SDL_GetRendererOutputSize() to query the
|
||
drawable size in pixels.</p>
|
||
<p>If the window is created with any of the SDL_WINDOW_OPENGL or
|
||
SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function
|
||
(SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the
|
||
corresponding UnloadLibrary function is called by SDL_DestroyWindow().</p>
|
||
<p>If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver,
|
||
SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail.</p>
|
||
<p>\note On non-Apple devices, SDL requires you to either not link to the
|
||
Vulkan loader or link to a dynamic library version. This limitation
|
||
may be removed in a future version of SDL.</p>
|
||
<p>\sa SDL_DestroyWindow()
|
||
\sa SDL_GL_LoadLibrary()
|
||
\sa SDL_Vulkan_LoadLibrary()</p>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "sdl2_sys";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |