[{"data":1,"prerenderedAt":563},["ShallowReactive",2],{"fgnn4ToWQJ":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":562,"_id":4},"vkGetPhysicalDeviceDisplayPlanePropertiesKHR","Query the plane properties","VK_KHR_display","protos",[],{"type":10,"children":11,"toc":560},"root",[12,44,301,354,434,554],{"type":13,"tag":14,"props":15,"children":16},"element","p",{},[17,20,25,27,31,33,37,39,42],{"type":18,"value":19},"text","Images are presented to individual planes on a display.\nDevices ",{"type":13,"tag":21,"props":22,"children":24},"normative",{"type":23},"must",[],{"type":18,"value":26}," support at least one plane on each display.\nPlanes ",{"type":13,"tag":21,"props":28,"children":30},{"type":29},"can",[],{"type":18,"value":32}," be stacked and blended to composite multiple images on one\ndisplay.\nDevices ",{"type":13,"tag":21,"props":34,"children":36},{"type":35},"may",[],{"type":18,"value":38}," support only a fixed stacking order and fixed mapping between\nplanes and displays, or they ",{"type":13,"tag":21,"props":40,"children":41},{"type":35},[],{"type":18,"value":43}," allow arbitrary application-specified\nstacking orders and mappings between planes and displays.\nTo query the properties of device display planes, call:",{"type":13,"tag":45,"props":46,"children":47},"code-group",{},[48,146],{"type":13,"tag":49,"props":50,"children":56},"pre",{"className":51,"code":52,"filename":53,"language":54,"meta":55,"style":55},"language-c shiki shiki-themes github-light-default github-dark-default","VkResult vkGetPhysicalDeviceDisplayPlanePropertiesKHR(\n    VkPhysicalDevice physicalDevice,\n    uint32_t* pPropertyCount,\n    VkDisplayPlanePropertiesKHR* pProperties);\n","C","c","",[57],{"type":13,"tag":58,"props":59,"children":60},"code",{"__ignoreMap":55},[61,83,103,122],{"type":13,"tag":62,"props":63,"children":66},"span",{"class":64,"line":65},"line",1,[67,73,78],{"type":13,"tag":62,"props":68,"children":70},{"style":69},"--shiki-default:#1F2328;--shiki-dark:#E6EDF3",[71],{"type":18,"value":72},"VkResult ",{"type":13,"tag":62,"props":74,"children":76},{"style":75},"--shiki-default:#8250DF;--shiki-dark:#D2A8FF",[77],{"type":18,"value":4},{"type":13,"tag":62,"props":79,"children":80},{"style":69},[81],{"type":18,"value":82},"(\n",{"type":13,"tag":62,"props":84,"children":86},{"class":64,"line":85},2,[87,92,98],{"type":13,"tag":62,"props":88,"children":89},{"style":69},[90],{"type":18,"value":91},"    VkPhysicalDevice ",{"type":13,"tag":62,"props":93,"children":95},{"style":94},"--shiki-default:#953800;--shiki-dark:#FFA657",[96],{"type":18,"value":97},"physicalDevice",{"type":13,"tag":62,"props":99,"children":100},{"style":69},[101],{"type":18,"value":102},",\n",{"type":13,"tag":62,"props":104,"children":106},{"class":64,"line":105},3,[107,113,118],{"type":13,"tag":62,"props":108,"children":110},{"style":109},"--shiki-default:#CF222E;--shiki-dark:#FF7B72",[111],{"type":18,"value":112},"    uint32_t*",{"type":13,"tag":62,"props":114,"children":115},{"style":94},[116],{"type":18,"value":117}," pPropertyCount",{"type":13,"tag":62,"props":119,"children":120},{"style":69},[121],{"type":18,"value":102},{"type":13,"tag":62,"props":123,"children":125},{"class":64,"line":124},4,[126,131,136,141],{"type":13,"tag":62,"props":127,"children":128},{"style":69},[129],{"type":18,"value":130},"    VkDisplayPlanePropertiesKHR",{"type":13,"tag":62,"props":132,"children":133},{"style":109},[134],{"type":18,"value":135},"*",{"type":13,"tag":62,"props":137,"children":138},{"style":94},[139],{"type":18,"value":140}," pProperties",{"type":13,"tag":62,"props":142,"children":143},{"style":69},[144],{"type":18,"value":145},");\n",{"type":13,"tag":49,"props":147,"children":152},{"className":148,"code":149,"filename":150,"language":151,"meta":55,"style":55},"language-rs shiki shiki-themes github-light-default github-dark-default","pub fn get_physical_device_display_plane_properties_khr(\n    physical_device: vk::PhysicalDevice,\n    p_property_count: *mut u32,\n    p_properties: *mut vk::DisplayPlanePropertiesKHR,\n) -> vk::Result;\n","Rust","rs",[153],{"type":13,"tag":58,"props":154,"children":155},{"__ignoreMap":55},[156,178,210,236,269],{"type":13,"tag":62,"props":157,"children":158},{"class":64,"line":65},[159,164,169,174],{"type":13,"tag":62,"props":160,"children":161},{"style":109},[162],{"type":18,"value":163},"pub",{"type":13,"tag":62,"props":165,"children":166},{"style":109},[167],{"type":18,"value":168}," fn",{"type":13,"tag":62,"props":170,"children":171},{"style":75},[172],{"type":18,"value":173}," get_physical_device_display_plane_properties_khr",{"type":13,"tag":62,"props":175,"children":176},{"style":69},[177],{"type":18,"value":82},{"type":13,"tag":62,"props":179,"children":180},{"class":64,"line":85},[181,186,191,196,201,206],{"type":13,"tag":62,"props":182,"children":183},{"style":69},[184],{"type":18,"value":185},"    physical_device",{"type":13,"tag":62,"props":187,"children":188},{"style":109},[189],{"type":18,"value":190},":",{"type":13,"tag":62,"props":192,"children":193},{"style":94},[194],{"type":18,"value":195}," vk",{"type":13,"tag":62,"props":197,"children":198},{"style":109},[199],{"type":18,"value":200},"::",{"type":13,"tag":62,"props":202,"children":203},{"style":94},[204],{"type":18,"value":205},"PhysicalDevice",{"type":13,"tag":62,"props":207,"children":208},{"style":69},[209],{"type":18,"value":102},{"type":13,"tag":62,"props":211,"children":212},{"class":64,"line":105},[213,218,222,227,232],{"type":13,"tag":62,"props":214,"children":215},{"style":69},[216],{"type":18,"value":217},"    p_property_count",{"type":13,"tag":62,"props":219,"children":220},{"style":109},[221],{"type":18,"value":190},{"type":13,"tag":62,"props":223,"children":224},{"style":109},[225],{"type":18,"value":226}," *mut",{"type":13,"tag":62,"props":228,"children":229},{"style":94},[230],{"type":18,"value":231}," u32",{"type":13,"tag":62,"props":233,"children":234},{"style":69},[235],{"type":18,"value":102},{"type":13,"tag":62,"props":237,"children":238},{"class":64,"line":124},[239,244,248,252,256,260,265],{"type":13,"tag":62,"props":240,"children":241},{"style":69},[242],{"type":18,"value":243},"    p_properties",{"type":13,"tag":62,"props":245,"children":246},{"style":109},[247],{"type":18,"value":190},{"type":13,"tag":62,"props":249,"children":250},{"style":109},[251],{"type":18,"value":226},{"type":13,"tag":62,"props":253,"children":254},{"style":94},[255],{"type":18,"value":195},{"type":13,"tag":62,"props":257,"children":258},{"style":109},[259],{"type":18,"value":200},{"type":13,"tag":62,"props":261,"children":262},{"style":94},[263],{"type":18,"value":264},"DisplayPlanePropertiesKHR",{"type":13,"tag":62,"props":266,"children":267},{"style":69},[268],{"type":18,"value":102},{"type":13,"tag":62,"props":270,"children":272},{"class":64,"line":271},5,[273,278,283,287,291,296],{"type":13,"tag":62,"props":274,"children":275},{"style":69},[276],{"type":18,"value":277},") ",{"type":13,"tag":62,"props":279,"children":280},{"style":109},[281],{"type":18,"value":282},"->",{"type":13,"tag":62,"props":284,"children":285},{"style":94},[286],{"type":18,"value":195},{"type":13,"tag":62,"props":288,"children":289},{"style":109},[290],{"type":18,"value":200},{"type":13,"tag":62,"props":292,"children":293},{"style":94},[294],{"type":18,"value":295},"Result",{"type":13,"tag":62,"props":297,"children":298},{"style":69},[299],{"type":18,"value":300},";\n",{"type":13,"tag":302,"props":303,"children":304},"ul",{},[305,316,327],{"type":13,"tag":306,"props":307,"children":308},"li",{},[309,314],{"type":13,"tag":58,"props":310,"children":312},{"className":311},[],[313],{"type":18,"value":97},{"type":18,"value":315}," is a physical device.",{"type":13,"tag":306,"props":317,"children":318},{},[319,325],{"type":13,"tag":58,"props":320,"children":322},{"className":321},[],[323],{"type":18,"value":324},"pPropertyCount",{"type":18,"value":326}," is a pointer to an integer related to the number of\ndisplay planes available or queried, as described below.",{"type":13,"tag":306,"props":328,"children":329},{},[330,336,338,344,346,352],{"type":13,"tag":58,"props":331,"children":333},{"className":332},[],[334],{"type":18,"value":335},"pProperties",{"type":18,"value":337}," is either ",{"type":13,"tag":58,"props":339,"children":341},{"className":340},[],[342],{"type":18,"value":343},"NULL",{"type":18,"value":345}," or a pointer to an array of\n",{"type":13,"tag":58,"props":347,"children":349},{"className":348},[],[350],{"type":18,"value":351},"VkDisplayPlanePropertiesKHR",{"type":18,"value":353}," structures.",{"type":13,"tag":14,"props":355,"children":356},{},[357,359,364,366,371,373,378,380,385,387,392,394,397,399,404,406,411,413,418,420,425,427,432],{"type":18,"value":358},"If ",{"type":13,"tag":58,"props":360,"children":362},{"className":361},[],[363],{"type":18,"value":335},{"type":18,"value":365}," is ",{"type":13,"tag":58,"props":367,"children":369},{"className":368},[],[370],{"type":18,"value":343},{"type":18,"value":372},", then the number of display planes available\nfor ",{"type":13,"tag":58,"props":374,"children":376},{"className":375},[],[377],{"type":18,"value":97},{"type":18,"value":379}," is returned in ",{"type":13,"tag":58,"props":381,"children":383},{"className":382},[],[384],{"type":18,"value":324},{"type":18,"value":386},".\nOtherwise, ",{"type":13,"tag":58,"props":388,"children":390},{"className":389},[],[391],{"type":18,"value":324},{"type":18,"value":393}," ",{"type":13,"tag":21,"props":395,"children":396},{"type":23},[],{"type":18,"value":398}," point to a variable set by the\napplication to the number of elements in the ",{"type":13,"tag":58,"props":400,"children":402},{"className":401},[],[403],{"type":18,"value":335},{"type":18,"value":405}," array, and on\nreturn the variable is overwritten with the number of structures actually\nwritten to ",{"type":13,"tag":58,"props":407,"children":409},{"className":408},[],[410],{"type":18,"value":335},{"type":18,"value":412},".\nIf the value of ",{"type":13,"tag":58,"props":414,"children":416},{"className":415},[],[417],{"type":18,"value":324},{"type":18,"value":419}," is less than the number of display\nplanes for ",{"type":13,"tag":58,"props":421,"children":423},{"className":422},[],[424],{"type":18,"value":97},{"type":18,"value":426},", at most ",{"type":13,"tag":58,"props":428,"children":430},{"className":429},[],[431],{"type":18,"value":324},{"type":18,"value":433}," structures\nwill be written.",{"type":13,"tag":435,"props":436,"children":438},"validity-group",{"name":437},"Valid Usage (Implicit)",[439,467,493],{"type":13,"tag":440,"props":441,"children":443},"validity-field",{"name":442},"VUID-vkGetPhysicalDeviceDisplayPlanePropertiesKHR-physicalDevice-parameter",[444],{"type":13,"tag":14,"props":445,"children":446},{},[447,452,453,456,458,465],{"type":13,"tag":58,"props":448,"children":450},{"className":449},[],[451],{"type":18,"value":97},{"type":18,"value":393},{"type":13,"tag":21,"props":454,"children":455},{"type":23},[],{"type":18,"value":457}," be a valid ",{"type":13,"tag":459,"props":460,"children":462},"a",{"href":461},"/man/VkPhysicalDevice",[463],{"type":18,"value":464},"VkPhysicalDevice",{"type":18,"value":466}," handle",{"type":13,"tag":440,"props":468,"children":470},{"name":469},"VUID-vkGetPhysicalDeviceDisplayPlanePropertiesKHR-pPropertyCount-parameter",[471],{"type":13,"tag":14,"props":472,"children":473},{},[474,479,480,483,485,491],{"type":13,"tag":58,"props":475,"children":477},{"className":476},[],[478],{"type":18,"value":324},{"type":18,"value":393},{"type":13,"tag":21,"props":481,"children":482},{"type":23},[],{"type":18,"value":484}," be a valid pointer to a ",{"type":13,"tag":58,"props":486,"children":488},{"className":487},[],[489],{"type":18,"value":490},"uint32_t",{"type":18,"value":492}," value",{"type":13,"tag":440,"props":494,"children":496},{"name":495},"VUID-vkGetPhysicalDeviceDisplayPlanePropertiesKHR-pProperties-parameter",[497],{"type":13,"tag":14,"props":498,"children":499},{},[500,502,507,509,515,517,522,523,528,530,535,536,539,541,546,547,552],{"type":18,"value":501},"If the value referenced by ",{"type":13,"tag":58,"props":503,"children":505},{"className":504},[],[506],{"type":18,"value":324},{"type":18,"value":508}," is not ",{"type":13,"tag":58,"props":510,"children":512},{"className":511},[],[513],{"type":18,"value":514},"0",{"type":18,"value":516},", and ",{"type":13,"tag":58,"props":518,"children":520},{"className":519},[],[521],{"type":18,"value":335},{"type":18,"value":508},{"type":13,"tag":58,"props":524,"children":526},{"className":525},[],[527],{"type":18,"value":343},{"type":18,"value":529},", ",{"type":13,"tag":58,"props":531,"children":533},{"className":532},[],[534],{"type":18,"value":335},{"type":18,"value":393},{"type":13,"tag":21,"props":537,"children":538},{"type":23},[],{"type":18,"value":540}," be a valid pointer to an array of ",{"type":13,"tag":58,"props":542,"children":544},{"className":543},[],[545],{"type":18,"value":324},{"type":18,"value":393},{"type":13,"tag":459,"props":548,"children":550},{"href":549},"/man/VkDisplayPlanePropertiesKHR",[551],{"type":18,"value":351},{"type":18,"value":553}," structures",{"type":13,"tag":555,"props":556,"children":557},"style",{},[558],{"type":18,"value":559},"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":55,"searchDepth":85,"depth":85,"links":561},[],"markdown",1729612516522]