[{"data":1,"prerenderedAt":506},["ShallowReactive",2],{"ksc458jbrx":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":505,"_id":4},"vkAcquireXlibDisplayEXT","Acquire access to a VkDisplayKHR using Xlib","VK_EXT_acquire_xlib_display","protos",[],{"type":10,"children":11,"toc":503},"root",[12,20,273,316,381,390,497],{"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 from an X11\nserver, call:",{"type":13,"tag":21,"props":22,"children":23},"code-group",{},[24,122],{"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 vkAcquireXlibDisplayEXT(\n    VkPhysicalDevice physicalDevice,\n    Display* dpy,\n    VkDisplayKHR display);\n","C","c","",[33],{"type":13,"tag":34,"props":35,"children":36},"code",{"__ignoreMap":31},[37,59,79,103],{"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,94,99],{"type":13,"tag":38,"props":84,"children":85},{"style":45},[86],{"type":18,"value":87},"    Display",{"type":13,"tag":38,"props":89,"children":91},{"style":90},"--shiki-default:#CF222E;--shiki-dark:#FF7B72",[92],{"type":18,"value":93},"*",{"type":13,"tag":38,"props":95,"children":96},{"style":70},[97],{"type":18,"value":98}," dpy",{"type":13,"tag":38,"props":100,"children":101},{"style":45},[102],{"type":18,"value":78},{"type":13,"tag":38,"props":104,"children":106},{"class":40,"line":105},4,[107,112,117],{"type":13,"tag":38,"props":108,"children":109},{"style":45},[110],{"type":18,"value":111},"    VkDisplayKHR ",{"type":13,"tag":38,"props":113,"children":114},{"style":70},[115],{"type":18,"value":116},"display",{"type":13,"tag":38,"props":118,"children":119},{"style":45},[120],{"type":18,"value":121},");\n",{"type":13,"tag":25,"props":123,"children":128},{"className":124,"code":125,"filename":126,"language":127,"meta":31,"style":31},"language-rs shiki shiki-themes github-light-default github-dark-default","pub fn acquire_xlib_display_ext(\n    physical_device: vk::PhysicalDevice,\n    dpy: *mut Display,\n    display: vk::DisplayKHR,\n) -> vk::Result;\n","Rust","rs",[129],{"type":13,"tag":34,"props":130,"children":131},{"__ignoreMap":31},[132,154,186,212,241],{"type":13,"tag":38,"props":133,"children":134},{"class":40,"line":41},[135,140,145,150],{"type":13,"tag":38,"props":136,"children":137},{"style":90},[138],{"type":18,"value":139},"pub",{"type":13,"tag":38,"props":141,"children":142},{"style":90},[143],{"type":18,"value":144}," fn",{"type":13,"tag":38,"props":146,"children":147},{"style":51},[148],{"type":18,"value":149}," acquire_xlib_display_ext",{"type":13,"tag":38,"props":151,"children":152},{"style":45},[153],{"type":18,"value":58},{"type":13,"tag":38,"props":155,"children":156},{"class":40,"line":61},[157,162,167,172,177,182],{"type":13,"tag":38,"props":158,"children":159},{"style":45},[160],{"type":18,"value":161},"    physical_device",{"type":13,"tag":38,"props":163,"children":164},{"style":90},[165],{"type":18,"value":166},":",{"type":13,"tag":38,"props":168,"children":169},{"style":70},[170],{"type":18,"value":171}," vk",{"type":13,"tag":38,"props":173,"children":174},{"style":90},[175],{"type":18,"value":176},"::",{"type":13,"tag":38,"props":178,"children":179},{"style":70},[180],{"type":18,"value":181},"PhysicalDevice",{"type":13,"tag":38,"props":183,"children":184},{"style":45},[185],{"type":18,"value":78},{"type":13,"tag":38,"props":187,"children":188},{"class":40,"line":81},[189,194,198,203,208],{"type":13,"tag":38,"props":190,"children":191},{"style":45},[192],{"type":18,"value":193},"    dpy",{"type":13,"tag":38,"props":195,"children":196},{"style":90},[197],{"type":18,"value":166},{"type":13,"tag":38,"props":199,"children":200},{"style":90},[201],{"type":18,"value":202}," *mut",{"type":13,"tag":38,"props":204,"children":205},{"style":70},[206],{"type":18,"value":207}," Display",{"type":13,"tag":38,"props":209,"children":210},{"style":45},[211],{"type":18,"value":78},{"type":13,"tag":38,"props":213,"children":214},{"class":40,"line":105},[215,220,224,228,232,237],{"type":13,"tag":38,"props":216,"children":217},{"style":45},[218],{"type":18,"value":219},"    display",{"type":13,"tag":38,"props":221,"children":222},{"style":90},[223],{"type":18,"value":166},{"type":13,"tag":38,"props":225,"children":226},{"style":70},[227],{"type":18,"value":171},{"type":13,"tag":38,"props":229,"children":230},{"style":90},[231],{"type":18,"value":176},{"type":13,"tag":38,"props":233,"children":234},{"style":70},[235],{"type":18,"value":236},"DisplayKHR",{"type":13,"tag":38,"props":238,"children":239},{"style":45},[240],{"type":18,"value":78},{"type":13,"tag":38,"props":242,"children":244},{"class":40,"line":243},5,[245,250,255,259,263,268],{"type":13,"tag":38,"props":246,"children":247},{"style":45},[248],{"type":18,"value":249},") ",{"type":13,"tag":38,"props":251,"children":252},{"style":90},[253],{"type":18,"value":254},"->",{"type":13,"tag":38,"props":256,"children":257},{"style":70},[258],{"type":18,"value":171},{"type":13,"tag":38,"props":260,"children":261},{"style":90},[262],{"type":18,"value":176},{"type":13,"tag":38,"props":264,"children":265},{"style":70},[266],{"type":18,"value":267},"Result",{"type":13,"tag":38,"props":269,"children":270},{"style":45},[271],{"type":18,"value":272},";\n",{"type":13,"tag":274,"props":275,"children":276},"ul",{},[277,288,306],{"type":13,"tag":278,"props":279,"children":280},"li",{},[281,286],{"type":13,"tag":34,"props":282,"children":284},{"className":283},[],[285],{"type":18,"value":73},{"type":18,"value":287}," The physical device the display is on.",{"type":13,"tag":278,"props":289,"children":290},{},[291,297,299,304],{"type":13,"tag":34,"props":292,"children":294},{"className":293},[],[295],{"type":18,"value":296},"dpy",{"type":18,"value":298}," A connection to the X11 server that currently owns\n",{"type":13,"tag":34,"props":300,"children":302},{"className":301},[],[303],{"type":18,"value":116},{"type":18,"value":305},".",{"type":13,"tag":278,"props":307,"children":308},{},[309,314],{"type":13,"tag":34,"props":310,"children":312},{"className":311},[],[313],{"type":18,"value":116},{"type":18,"value":315}," The display the caller wishes to control in Vulkan.",{"type":13,"tag":14,"props":317,"children":318},{},[319,321,326,328,333,335,340,342,347,349,353,355,360,362,367,369,372,374,380],{"type":18,"value":320},"All permissions necessary to control the display are granted to the Vulkan\ninstance associated with ",{"type":13,"tag":34,"props":322,"children":324},{"className":323},[],[325],{"type":18,"value":73},{"type":18,"value":327}," until the display is released\nor the X11 connection specified by ",{"type":13,"tag":34,"props":329,"children":331},{"className":330},[],[332],{"type":18,"value":296},{"type":18,"value":334}," is terminated.\nPermission to access the display ",{"type":13,"tag":336,"props":337,"children":339},"normative",{"type":338},"may",[],{"type":18,"value":341}," be temporarily revoked during periods\nwhen the X11 server from which control was acquired itself loses access to\n",{"type":13,"tag":34,"props":343,"children":345},{"className":344},[],[346],{"type":18,"value":116},{"type":18,"value":348},".\nDuring such periods, operations which require access to the display ",{"type":13,"tag":336,"props":350,"children":352},{"type":351},"must",[],{"type":18,"value":354},"\nfail with an appropriate error code.\nIf the X11 server associated with ",{"type":13,"tag":34,"props":356,"children":358},{"className":357},[],[359],{"type":18,"value":296},{"type":18,"value":361}," does not own ",{"type":13,"tag":34,"props":363,"children":365},{"className":364},[],[366],{"type":18,"value":116},{"type":18,"value":368},", or\nif permission to access it has already been acquired by another entity, the\ncall ",{"type":13,"tag":336,"props":370,"children":371},{"type":351},[],{"type":18,"value":373}," return the error code ",{"type":13,"tag":34,"props":375,"children":377},{"className":376},[],[378],{"type":18,"value":379},"VK_ERROR_INITIALIZATION_FAILED",{"type":18,"value":305},{"type":13,"tag":382,"props":383,"children":384},"note",{},[385],{"type":13,"tag":14,"props":386,"children":387},{},[388],{"type":18,"value":389},"One example of when an X11 server loses access to a display is when it loses\nownership of its virtual terminal.",{"type":13,"tag":391,"props":392,"children":394},"validity-group",{"name":393},"Valid Usage (Implicit)",[395,424,450,474],{"type":13,"tag":396,"props":397,"children":399},"validity-field",{"name":398},"VUID-vkAcquireXlibDisplayEXT-physicalDevice-parameter",[400],{"type":13,"tag":14,"props":401,"children":402},{},[403,408,410,413,415,422],{"type":13,"tag":34,"props":404,"children":406},{"className":405},[],[407],{"type":18,"value":73},{"type":18,"value":409}," ",{"type":13,"tag":336,"props":411,"children":412},{"type":351},[],{"type":18,"value":414}," be a valid ",{"type":13,"tag":416,"props":417,"children":419},"a",{"href":418},"/man/VkPhysicalDevice",[420],{"type":18,"value":421},"VkPhysicalDevice",{"type":18,"value":423}," handle",{"type":13,"tag":396,"props":425,"children":427},{"name":426},"VUID-vkAcquireXlibDisplayEXT-dpy-parameter",[428],{"type":13,"tag":14,"props":429,"children":430},{},[431,436,437,440,442,448],{"type":13,"tag":34,"props":432,"children":434},{"className":433},[],[435],{"type":18,"value":296},{"type":18,"value":409},{"type":13,"tag":336,"props":438,"children":439},{"type":351},[],{"type":18,"value":441}," be a valid pointer to a ",{"type":13,"tag":34,"props":443,"children":445},{"className":444},[],[446],{"type":18,"value":447},"Display",{"type":18,"value":449}," value",{"type":13,"tag":396,"props":451,"children":453},{"name":452},"VUID-vkAcquireXlibDisplayEXT-display-parameter",[454],{"type":13,"tag":14,"props":455,"children":456},{},[457,462,463,466,467,473],{"type":13,"tag":34,"props":458,"children":460},{"className":459},[],[461],{"type":18,"value":116},{"type":18,"value":409},{"type":13,"tag":336,"props":464,"children":465},{"type":351},[],{"type":18,"value":414},{"type":13,"tag":416,"props":468,"children":470},{"href":469},"/man/VkDisplayKHR",[471],{"type":18,"value":472},"VkDisplayKHR",{"type":18,"value":423},{"type":13,"tag":396,"props":475,"children":477},{"name":476},"VUID-vkAcquireXlibDisplayEXT-display-parent",[478],{"type":13,"tag":14,"props":479,"children":480},{},[481,486,487,490,492],{"type":13,"tag":34,"props":482,"children":484},{"className":483},[],[485],{"type":18,"value":116},{"type":18,"value":409},{"type":13,"tag":336,"props":488,"children":489},{"type":351},[],{"type":18,"value":491}," have been created, allocated, or retrieved from ",{"type":13,"tag":34,"props":493,"children":495},{"className":494},[],[496],{"type":18,"value":73},{"type":13,"tag":498,"props":499,"children":500},"style",{},[501],{"type":18,"value":502},"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":504},[],"markdown",1725732596654]