[{"data":1,"prerenderedAt":473},["ShallowReactive",2],{"uY7zbg0B1A":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":472,"_id":4},"vkAcquireWinrtDisplayNV","Acquire access to a VkDisplayKHR","VK_NV_acquire_winrt_display","protos",[],{"type":10,"children":11,"toc":470},"root",[12,20,224,249,301,345,353,384,464],{"type":13,"tag":14,"props":15,"children":16},"element","p",{},[17],{"type":18,"value":19},"text","To acquire permission to directly access a display in Vulkan on Windows 10,\ncall:",{"type":13,"tag":21,"props":22,"children":23},"code-group",{},[24,98],{"type":13,"tag":25,"props":26,"children":32},"pre",{"className":27,"code":28,"filename":29,"language":30,"meta":31,"style":31},"language-c shiki shiki-themes github-light-default github-dark-default","VkResult vkAcquireWinrtDisplayNV(\n VkPhysicalDevice physicalDevice,\n VkDisplayKHR display);\n","C","c","",[33],{"type":13,"tag":34,"props":35,"children":36},"code",{"__ignoreMap":31},[37,59,79],{"type":13,"tag":38,"props":39,"children":42},"span",{"class":40,"line":41},"line",1,[43,49,54],{"type":13,"tag":38,"props":44,"children":46},{"style":45},"--shiki-default:#1F2328;--shiki-dark:#E6EDF3",[47],{"type":18,"value":48},"VkResult ",{"type":13,"tag":38,"props":50,"children":52},{"style":51},"--shiki-default:#8250DF;--shiki-dark:#D2A8FF",[53],{"type":18,"value":4},{"type":13,"tag":38,"props":55,"children":56},{"style":45},[57],{"type":18,"value":58},"(\n",{"type":13,"tag":38,"props":60,"children":62},{"class":40,"line":61},2,[63,68,74],{"type":13,"tag":38,"props":64,"children":65},{"style":45},[66],{"type":18,"value":67}," VkPhysicalDevice ",{"type":13,"tag":38,"props":69,"children":71},{"style":70},"--shiki-default:#953800;--shiki-dark:#FFA657",[72],{"type":18,"value":73},"physicalDevice",{"type":13,"tag":38,"props":75,"children":76},{"style":45},[77],{"type":18,"value":78},",\n",{"type":13,"tag":38,"props":80,"children":82},{"class":40,"line":81},3,[83,88,93],{"type":13,"tag":38,"props":84,"children":85},{"style":45},[86],{"type":18,"value":87}," VkDisplayKHR ",{"type":13,"tag":38,"props":89,"children":90},{"style":70},[91],{"type":18,"value":92},"display",{"type":13,"tag":38,"props":94,"children":95},{"style":45},[96],{"type":18,"value":97},");\n",{"type":13,"tag":25,"props":99,"children":104},{"className":100,"code":101,"filename":102,"language":103,"meta":31,"style":31},"language-rs shiki shiki-themes github-light-default github-dark-default","pub fn acquire_winrt_display_nv(\n physical_device: vk::PhysicalDevice,\n display: vk::DisplayKHR,\n) -> vk::Result;\n","Rust","rs",[105],{"type":13,"tag":34,"props":106,"children":107},{"__ignoreMap":31},[108,131,163,192],{"type":13,"tag":38,"props":109,"children":110},{"class":40,"line":41},[111,117,122,127],{"type":13,"tag":38,"props":112,"children":114},{"style":113},"--shiki-default:#CF222E;--shiki-dark:#FF7B72",[115],{"type":18,"value":116},"pub",{"type":13,"tag":38,"props":118,"children":119},{"style":113},[120],{"type":18,"value":121}," fn",{"type":13,"tag":38,"props":123,"children":124},{"style":51},[125],{"type":18,"value":126}," acquire_winrt_display_nv",{"type":13,"tag":38,"props":128,"children":129},{"style":45},[130],{"type":18,"value":58},{"type":13,"tag":38,"props":132,"children":133},{"class":40,"line":61},[134,139,144,149,154,159],{"type":13,"tag":38,"props":135,"children":136},{"style":45},[137],{"type":18,"value":138}," physical_device",{"type":13,"tag":38,"props":140,"children":141},{"style":113},[142],{"type":18,"value":143},":",{"type":13,"tag":38,"props":145,"children":146},{"style":70},[147],{"type":18,"value":148}," vk",{"type":13,"tag":38,"props":150,"children":151},{"style":113},[152],{"type":18,"value":153},"::",{"type":13,"tag":38,"props":155,"children":156},{"style":70},[157],{"type":18,"value":158},"PhysicalDevice",{"type":13,"tag":38,"props":160,"children":161},{"style":45},[162],{"type":18,"value":78},{"type":13,"tag":38,"props":164,"children":165},{"class":40,"line":81},[166,171,175,179,183,188],{"type":13,"tag":38,"props":167,"children":168},{"style":45},[169],{"type":18,"value":170}," display",{"type":13,"tag":38,"props":172,"children":173},{"style":113},[174],{"type":18,"value":143},{"type":13,"tag":38,"props":176,"children":177},{"style":70},[178],{"type":18,"value":148},{"type":13,"tag":38,"props":180,"children":181},{"style":113},[182],{"type":18,"value":153},{"type":13,"tag":38,"props":184,"children":185},{"style":70},[186],{"type":18,"value":187},"DisplayKHR",{"type":13,"tag":38,"props":189,"children":190},{"style":45},[191],{"type":18,"value":78},{"type":13,"tag":38,"props":193,"children":195},{"class":40,"line":194},4,[196,201,206,210,214,219],{"type":13,"tag":38,"props":197,"children":198},{"style":45},[199],{"type":18,"value":200},") ",{"type":13,"tag":38,"props":202,"children":203},{"style":113},[204],{"type":18,"value":205},"->",{"type":13,"tag":38,"props":207,"children":208},{"style":70},[209],{"type":18,"value":148},{"type":13,"tag":38,"props":211,"children":212},{"style":113},[213],{"type":18,"value":153},{"type":13,"tag":38,"props":215,"children":216},{"style":70},[217],{"type":18,"value":218},"Result",{"type":13,"tag":38,"props":220,"children":221},{"style":45},[222],{"type":18,"value":223},";\n",{"type":13,"tag":225,"props":226,"children":227},"ul",{},[228,239],{"type":13,"tag":229,"props":230,"children":231},"li",{},[232,237],{"type":13,"tag":34,"props":233,"children":235},{"className":234},[],[236],{"type":18,"value":73},{"type":18,"value":238}," The physical device the display is on.",{"type":13,"tag":229,"props":240,"children":241},{},[242,247],{"type":13,"tag":34,"props":243,"children":245},{"className":244},[],[246],{"type":18,"value":92},{"type":18,"value":248}," The display the caller wishes to control in Vulkan.",{"type":13,"tag":14,"props":250,"children":251},{},[252,254,259,261,266,268,273,275,279,281,286,288,291,293,299],{"type":18,"value":253},"All permissions necessary to control the display are granted to the Vulkan\ninstance associated with ",{"type":13,"tag":34,"props":255,"children":257},{"className":256},[],[258],{"type":18,"value":73},{"type":18,"value":260}," until the display is released\nor the application is terminated.\nPermission to access the display ",{"type":13,"tag":262,"props":263,"children":265},"normative",{"type":264},"may",[],{"type":18,"value":267}," be revoked by events that cause\nWindows 10 itself to lose access to ",{"type":13,"tag":34,"props":269,"children":271},{"className":270},[],[272],{"type":18,"value":92},{"type":18,"value":274},".\nIf this has happened, operations which require access to the display ",{"type":13,"tag":262,"props":276,"children":278},{"type":277},"must",[],{"type":18,"value":280},"\nfail with an appropriate error code.\nIf permission to access ",{"type":13,"tag":34,"props":282,"children":284},{"className":283},[],[285],{"type":18,"value":92},{"type":18,"value":287}," has already been acquired by another\nentity, the call ",{"type":13,"tag":262,"props":289,"children":290},{"type":277},[],{"type":18,"value":292}," return the error code\n",{"type":13,"tag":34,"props":294,"children":296},{"className":295},[],[297],{"type":18,"value":298},"VK_ERROR_INITIALIZATION_FAILED",{"type":18,"value":300},".",{"type":13,"tag":302,"props":303,"children":304},"note",{},[305],{"type":13,"tag":14,"props":306,"children":307},{},[308,310,323,325,336,338,344],{"type":18,"value":309},"The Vulkan instance acquires control of a\n",{"type":13,"tag":311,"props":312,"children":316},"a",{"href":313,"rel":314},"https://docs.microsoft.com/en-us/uwp/api/windows.devices.display.core.displaytarget",[315],"nofollow",[317],{"type":13,"tag":34,"props":318,"children":320},{"className":319},[],[321],{"type":18,"value":322},"winrt::Windows::Devices::Display::Core::DisplayTarget",{"type":18,"value":324},"\nby performing an operation equivalent to\n",{"type":13,"tag":311,"props":326,"children":329},{"href":327,"rel":328},"https://docs.microsoft.com/en-us/uwp/api/windows.devices.display.core.displaymanager.tryacquiretarget",[315],[330],{"type":13,"tag":34,"props":331,"children":333},{"className":332},[],[334],{"type":18,"value":335},"winrt::Windows::Devices::Display::Core::DisplayManager.TryAcquireTarget()",{"type":18,"value":337},"\non the ",{"type":13,"tag":34,"props":339,"children":341},{"className":340},[],[342],{"type":18,"value":343},"DisplayTarget",{"type":18,"value":300},{"type":13,"tag":302,"props":346,"children":347},{},[348],{"type":13,"tag":14,"props":349,"children":350},{},[351],{"type":18,"value":352},"One example of when Windows 10 loses access to a display is when the display\nis hot-unplugged.",{"type":13,"tag":302,"props":354,"children":355},{},[356],{"type":13,"tag":14,"props":357,"children":358},{},[359,361,367,369,375,377,382],{"type":18,"value":360},"One example of when a display has already been acquired by another entity is\nwhen the Windows desktop compositor (DWM) is in control of the display.\nBeginning with Windows 10 version 2004 it is possible to cause DWM to\nrelease a display by using the ",{"type":13,"tag":34,"props":362,"children":364},{"className":363},[],[365],{"type":18,"value":366},"Advanced display settings",{"type":18,"value":368}," sub-page of the\n",{"type":13,"tag":34,"props":370,"children":372},{"className":371},[],[373],{"type":18,"value":374},"Display settings",{"type":18,"value":376}," control panel.\n",{"type":13,"tag":311,"props":378,"children":380},{"href":379},"/man/vkAcquireWinrtDisplayNV",[381],{"type":18,"value":4},{"type":18,"value":383}," does not itself cause DWM to release a\ndisplay; this action must be performed outside of Vulkan.",{"type":13,"tag":385,"props":386,"children":388},"validity-group",{"name":387},"Valid Usage (Implicit)",[389,417,441],{"type":13,"tag":390,"props":391,"children":393},"validity-field",{"name":392},"VUID-vkAcquireWinrtDisplayNV-physicalDevice-parameter",[394],{"type":13,"tag":14,"props":395,"children":396},{},[397,402,404,407,409,415],{"type":13,"tag":34,"props":398,"children":400},{"className":399},[],[401],{"type":18,"value":73},{"type":18,"value":403}," ",{"type":13,"tag":262,"props":405,"children":406},{"type":277},[],{"type":18,"value":408}," be a valid ",{"type":13,"tag":311,"props":410,"children":412},{"href":411},"/man/VkPhysicalDevice",[413],{"type":18,"value":414},"VkPhysicalDevice",{"type":18,"value":416}," handle",{"type":13,"tag":390,"props":418,"children":420},{"name":419},"VUID-vkAcquireWinrtDisplayNV-display-parameter",[421],{"type":13,"tag":14,"props":422,"children":423},{},[424,429,430,433,434,440],{"type":13,"tag":34,"props":425,"children":427},{"className":426},[],[428],{"type":18,"value":92},{"type":18,"value":403},{"type":13,"tag":262,"props":431,"children":432},{"type":277},[],{"type":18,"value":408},{"type":13,"tag":311,"props":435,"children":437},{"href":436},"/man/VkDisplayKHR",[438],{"type":18,"value":439},"VkDisplayKHR",{"type":18,"value":416},{"type":13,"tag":390,"props":442,"children":444},{"name":443},"VUID-vkAcquireWinrtDisplayNV-display-parent",[445],{"type":13,"tag":14,"props":446,"children":447},{},[448,453,454,457,459],{"type":13,"tag":34,"props":449,"children":451},{"className":450},[],[452],{"type":18,"value":92},{"type":18,"value":403},{"type":13,"tag":262,"props":455,"children":456},{"type":277},[],{"type":18,"value":458}," have been created, allocated, or retrieved from ",{"type":13,"tag":34,"props":460,"children":462},{"className":461},[],[463],{"type":18,"value":73},{"type":13,"tag":465,"props":466,"children":467},"style",{},[468],{"type":18,"value":469},"html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":31,"searchDepth":61,"depth":61,"links":471},[],"markdown",1729612490570]