[{"data":1,"prerenderedAt":646},["ShallowReactive",2],{"Sb74NkqWrs":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":645,"_id":4},"vkGetDisplayPlaneSupportedDisplaysKHR","Query the list of displays a plane supports","VK_KHR_display","protos",[],{"type":10,"children":11,"toc":643},"root",[12,20,315,386,489,519,637],{"type":13,"tag":14,"props":15,"children":16},"element","p",{},[17],{"type":18,"value":19},"text","To determine which displays a plane is usable with, call",{"type":13,"tag":21,"props":22,"children":23},"code-group",{},[24,140],{"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 vkGetDisplayPlaneSupportedDisplaysKHR(\n VkPhysicalDevice physicalDevice,\n uint32_t planeIndex,\n uint32_t* pDisplayCount,\n VkDisplayKHR* pDisplays);\n","C","c","",[33],{"type":13,"tag":34,"props":35,"children":36},"code",{"__ignoreMap":31},[37,59,79,98,116],{"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,89,94],{"type":13,"tag":38,"props":84,"children":86},{"style":85},"--shiki-default:#CF222E;--shiki-dark:#FF7B72",[87],{"type":18,"value":88}," uint32_t",{"type":13,"tag":38,"props":90,"children":91},{"style":70},[92],{"type":18,"value":93}," planeIndex",{"type":13,"tag":38,"props":95,"children":96},{"style":45},[97],{"type":18,"value":78},{"type":13,"tag":38,"props":99,"children":101},{"class":40,"line":100},4,[102,107,112],{"type":13,"tag":38,"props":103,"children":104},{"style":85},[105],{"type":18,"value":106}," uint32_t*",{"type":13,"tag":38,"props":108,"children":109},{"style":70},[110],{"type":18,"value":111}," pDisplayCount",{"type":13,"tag":38,"props":113,"children":114},{"style":45},[115],{"type":18,"value":78},{"type":13,"tag":38,"props":117,"children":119},{"class":40,"line":118},5,[120,125,130,135],{"type":13,"tag":38,"props":121,"children":122},{"style":45},[123],{"type":18,"value":124}," VkDisplayKHR",{"type":13,"tag":38,"props":126,"children":127},{"style":85},[128],{"type":18,"value":129},"*",{"type":13,"tag":38,"props":131,"children":132},{"style":70},[133],{"type":18,"value":134}," pDisplays",{"type":13,"tag":38,"props":136,"children":137},{"style":45},[138],{"type":18,"value":139},");\n",{"type":13,"tag":25,"props":141,"children":146},{"className":142,"code":143,"filename":144,"language":145,"meta":31,"style":31},"language-rs shiki shiki-themes github-light-default github-dark-default","pub fn get_display_plane_supported_displays_khr(\n physical_device: vk::PhysicalDevice,\n plane_index: u32,\n p_display_count: *mut u32,\n p_displays: *mut vk::DisplayKHR,\n) -> vk::Result;\n","Rust","rs",[147],{"type":13,"tag":34,"props":148,"children":149},{"__ignoreMap":31},[150,172,204,225,250,283],{"type":13,"tag":38,"props":151,"children":152},{"class":40,"line":41},[153,158,163,168],{"type":13,"tag":38,"props":154,"children":155},{"style":85},[156],{"type":18,"value":157},"pub",{"type":13,"tag":38,"props":159,"children":160},{"style":85},[161],{"type":18,"value":162}," fn",{"type":13,"tag":38,"props":164,"children":165},{"style":51},[166],{"type":18,"value":167}," get_display_plane_supported_displays_khr",{"type":13,"tag":38,"props":169,"children":170},{"style":45},[171],{"type":18,"value":58},{"type":13,"tag":38,"props":173,"children":174},{"class":40,"line":61},[175,180,185,190,195,200],{"type":13,"tag":38,"props":176,"children":177},{"style":45},[178],{"type":18,"value":179}," physical_device",{"type":13,"tag":38,"props":181,"children":182},{"style":85},[183],{"type":18,"value":184},":",{"type":13,"tag":38,"props":186,"children":187},{"style":70},[188],{"type":18,"value":189}," vk",{"type":13,"tag":38,"props":191,"children":192},{"style":85},[193],{"type":18,"value":194},"::",{"type":13,"tag":38,"props":196,"children":197},{"style":70},[198],{"type":18,"value":199},"PhysicalDevice",{"type":13,"tag":38,"props":201,"children":202},{"style":45},[203],{"type":18,"value":78},{"type":13,"tag":38,"props":205,"children":206},{"class":40,"line":81},[207,212,216,221],{"type":13,"tag":38,"props":208,"children":209},{"style":45},[210],{"type":18,"value":211}," plane_index",{"type":13,"tag":38,"props":213,"children":214},{"style":85},[215],{"type":18,"value":184},{"type":13,"tag":38,"props":217,"children":218},{"style":70},[219],{"type":18,"value":220}," u32",{"type":13,"tag":38,"props":222,"children":223},{"style":45},[224],{"type":18,"value":78},{"type":13,"tag":38,"props":226,"children":227},{"class":40,"line":100},[228,233,237,242,246],{"type":13,"tag":38,"props":229,"children":230},{"style":45},[231],{"type":18,"value":232}," p_display_count",{"type":13,"tag":38,"props":234,"children":235},{"style":85},[236],{"type":18,"value":184},{"type":13,"tag":38,"props":238,"children":239},{"style":85},[240],{"type":18,"value":241}," *mut",{"type":13,"tag":38,"props":243,"children":244},{"style":70},[245],{"type":18,"value":220},{"type":13,"tag":38,"props":247,"children":248},{"style":45},[249],{"type":18,"value":78},{"type":13,"tag":38,"props":251,"children":252},{"class":40,"line":118},[253,258,262,266,270,274,279],{"type":13,"tag":38,"props":254,"children":255},{"style":45},[256],{"type":18,"value":257}," p_displays",{"type":13,"tag":38,"props":259,"children":260},{"style":85},[261],{"type":18,"value":184},{"type":13,"tag":38,"props":263,"children":264},{"style":85},[265],{"type":18,"value":241},{"type":13,"tag":38,"props":267,"children":268},{"style":70},[269],{"type":18,"value":189},{"type":13,"tag":38,"props":271,"children":272},{"style":85},[273],{"type":18,"value":194},{"type":13,"tag":38,"props":275,"children":276},{"style":70},[277],{"type":18,"value":278},"DisplayKHR",{"type":13,"tag":38,"props":280,"children":281},{"style":45},[282],{"type":18,"value":78},{"type":13,"tag":38,"props":284,"children":286},{"class":40,"line":285},6,[287,292,297,301,305,310],{"type":13,"tag":38,"props":288,"children":289},{"style":45},[290],{"type":18,"value":291},") ",{"type":13,"tag":38,"props":293,"children":294},{"style":85},[295],{"type":18,"value":296},"->",{"type":13,"tag":38,"props":298,"children":299},{"style":70},[300],{"type":18,"value":189},{"type":13,"tag":38,"props":302,"children":303},{"style":85},[304],{"type":18,"value":194},{"type":13,"tag":38,"props":306,"children":307},{"style":70},[308],{"type":18,"value":309},"Result",{"type":13,"tag":38,"props":311,"children":312},{"style":45},[313],{"type":18,"value":314},";\n",{"type":13,"tag":316,"props":317,"children":318},"ul",{},[319,330,348,359],{"type":13,"tag":320,"props":321,"children":322},"li",{},[323,328],{"type":13,"tag":34,"props":324,"children":326},{"className":325},[],[327],{"type":18,"value":73},{"type":18,"value":329}," is a physical device.",{"type":13,"tag":320,"props":331,"children":332},{},[333,339,341,346],{"type":13,"tag":34,"props":334,"children":336},{"className":335},[],[337],{"type":18,"value":338},"planeIndex",{"type":18,"value":340}," is the plane which the application wishes to use, and\n",{"type":13,"tag":342,"props":343,"children":345},"normative",{"type":344},"must",[],{"type":18,"value":347}," be in the range [0, physical device plane count - 1].",{"type":13,"tag":320,"props":349,"children":350},{},[351,357],{"type":13,"tag":34,"props":352,"children":354},{"className":353},[],[355],{"type":18,"value":356},"pDisplayCount",{"type":18,"value":358}," is a pointer to an integer related to the number of\ndisplays available or queried, as described below.",{"type":13,"tag":320,"props":360,"children":361},{},[362,368,370,376,378,384],{"type":13,"tag":34,"props":363,"children":365},{"className":364},[],[366],{"type":18,"value":367},"pDisplays",{"type":18,"value":369}," is either ",{"type":13,"tag":34,"props":371,"children":373},{"className":372},[],[374],{"type":18,"value":375},"NULL",{"type":18,"value":377}," or a pointer to an array of\n",{"type":13,"tag":34,"props":379,"children":381},{"className":380},[],[382],{"type":18,"value":383},"VkDisplayKHR",{"type":18,"value":385}," handles.",{"type":13,"tag":14,"props":387,"children":388},{},[389,391,396,398,403,405,410,412,417,419,424,426,431,433,436,438,443,445,450,452,457,459,464,466,471,473,479,481,487],{"type":18,"value":390},"If ",{"type":13,"tag":34,"props":392,"children":394},{"className":393},[],[395],{"type":18,"value":367},{"type":18,"value":397}," is ",{"type":13,"tag":34,"props":399,"children":401},{"className":400},[],[402],{"type":18,"value":375},{"type":18,"value":404},", then the number of displays usable with the\nspecified ",{"type":13,"tag":34,"props":406,"children":408},{"className":407},[],[409],{"type":18,"value":338},{"type":18,"value":411}," for ",{"type":13,"tag":34,"props":413,"children":415},{"className":414},[],[416],{"type":18,"value":73},{"type":18,"value":418}," is returned in\n",{"type":13,"tag":34,"props":420,"children":422},{"className":421},[],[423],{"type":18,"value":356},{"type":18,"value":425},".\nOtherwise, ",{"type":13,"tag":34,"props":427,"children":429},{"className":428},[],[430],{"type":18,"value":356},{"type":18,"value":432}," ",{"type":13,"tag":342,"props":434,"children":435},{"type":344},[],{"type":18,"value":437}," point to a variable set by the\napplication to the number of elements in the ",{"type":13,"tag":34,"props":439,"children":441},{"className":440},[],[442],{"type":18,"value":367},{"type":18,"value":444}," array, and on\nreturn the variable is overwritten with the number of handles actually\nwritten to ",{"type":13,"tag":34,"props":446,"children":448},{"className":447},[],[449],{"type":18,"value":367},{"type":18,"value":451},".\nIf the value of ",{"type":13,"tag":34,"props":453,"children":455},{"className":454},[],[456],{"type":18,"value":356},{"type":18,"value":458}," is less than the number of usable\ndisplay-plane pairs for ",{"type":13,"tag":34,"props":460,"children":462},{"className":461},[],[463],{"type":18,"value":73},{"type":18,"value":465},", at most ",{"type":13,"tag":34,"props":467,"children":469},{"className":468},[],[470],{"type":18,"value":356},{"type":18,"value":472},"\nhandles will be written, and ",{"type":13,"tag":34,"props":474,"children":476},{"className":475},[],[477],{"type":18,"value":478},"VK_INCOMPLETE",{"type":18,"value":480}," will be returned instead of\n",{"type":13,"tag":34,"props":482,"children":484},{"className":483},[],[485],{"type":18,"value":486},"VK_SUCCESS",{"type":18,"value":488},", to indicate that not all the available pairs were\nreturned.",{"type":13,"tag":490,"props":491,"children":493},"validity-group",{"name":492},"Valid Usage",[494],{"type":13,"tag":495,"props":496,"children":498},"validity-field",{"name":497},"VUID-vkGetDisplayPlaneSupportedDisplaysKHR-planeIndex-01249",[499],{"type":13,"tag":14,"props":500,"children":501},{},[502,507,508,511,513],{"type":13,"tag":34,"props":503,"children":505},{"className":504},[],[506],{"type":18,"value":338},{"type":18,"value":432},{"type":13,"tag":342,"props":509,"children":510},{"type":344},[],{"type":18,"value":512}," be less than the number of display planes\nsupported by the device as determined by calling\n",{"type":13,"tag":34,"props":514,"children":516},{"className":515},[],[517],{"type":18,"value":518},"vkGetPhysicalDeviceDisplayPlanePropertiesKHR",{"type":13,"tag":490,"props":520,"children":522},{"name":521},"Valid Usage (Implicit)",[523,550,576],{"type":13,"tag":495,"props":524,"children":526},{"name":525},"VUID-vkGetDisplayPlaneSupportedDisplaysKHR-physicalDevice-parameter",[527],{"type":13,"tag":14,"props":528,"children":529},{},[530,535,536,539,541,548],{"type":13,"tag":34,"props":531,"children":533},{"className":532},[],[534],{"type":18,"value":73},{"type":18,"value":432},{"type":13,"tag":342,"props":537,"children":538},{"type":344},[],{"type":18,"value":540}," be a valid ",{"type":13,"tag":542,"props":543,"children":545},"a",{"href":544},"/man/VkPhysicalDevice",[546],{"type":18,"value":547},"VkPhysicalDevice",{"type":18,"value":549}," handle",{"type":13,"tag":495,"props":551,"children":553},{"name":552},"VUID-vkGetDisplayPlaneSupportedDisplaysKHR-pDisplayCount-parameter",[554],{"type":13,"tag":14,"props":555,"children":556},{},[557,562,563,566,568,574],{"type":13,"tag":34,"props":558,"children":560},{"className":559},[],[561],{"type":18,"value":356},{"type":18,"value":432},{"type":13,"tag":342,"props":564,"children":565},{"type":344},[],{"type":18,"value":567}," be a valid pointer to a ",{"type":13,"tag":34,"props":569,"children":571},{"className":570},[],[572],{"type":18,"value":573},"uint32_t",{"type":18,"value":575}," value",{"type":13,"tag":495,"props":577,"children":579},{"name":578},"VUID-vkGetDisplayPlaneSupportedDisplaysKHR-pDisplays-parameter",[580],{"type":13,"tag":14,"props":581,"children":582},{},[583,585,590,592,598,600,605,606,611,613,618,619,622,624,629,630,635],{"type":18,"value":584},"If the value referenced by ",{"type":13,"tag":34,"props":586,"children":588},{"className":587},[],[589],{"type":18,"value":356},{"type":18,"value":591}," is not ",{"type":13,"tag":34,"props":593,"children":595},{"className":594},[],[596],{"type":18,"value":597},"0",{"type":18,"value":599},", and ",{"type":13,"tag":34,"props":601,"children":603},{"className":602},[],[604],{"type":18,"value":367},{"type":18,"value":591},{"type":13,"tag":34,"props":607,"children":609},{"className":608},[],[610],{"type":18,"value":375},{"type":18,"value":612},", ",{"type":13,"tag":34,"props":614,"children":616},{"className":615},[],[617],{"type":18,"value":367},{"type":18,"value":432},{"type":13,"tag":342,"props":620,"children":621},{"type":344},[],{"type":18,"value":623}," be a valid pointer to an array of ",{"type":13,"tag":34,"props":625,"children":627},{"className":626},[],[628],{"type":18,"value":356},{"type":18,"value":432},{"type":13,"tag":542,"props":631,"children":633},{"href":632},"/man/VkDisplayKHR",[634],{"type":18,"value":383},{"type":18,"value":636}," handles",{"type":13,"tag":638,"props":639,"children":640},"style",{},[641],{"type":18,"value":642},"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":644},[],"markdown",1725732618062]