[{"data":1,"prerenderedAt":687},["ShallowReactive",2],{"1uaqyoFsWk":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":686,"_id":4},"vkGetSwapchainImagesKHR","Obtain the array of presentable images associated with a swapchain","VK_KHR_swapchain","protos",[],{"type":10,"children":11,"toc":684},"root",[12,20,343,413,511,678],{"type":13,"tag":14,"props":15,"children":16},"element","p",{},[17],{"type":18,"value":19},"text","To obtain the array of presentable images associated with a swapchain, 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 vkGetSwapchainImagesKHR(\n    VkDevice device,\n    VkSwapchainKHR swapchain,\n    uint32_t* pSwapchainImageCount,\n    VkImage* pSwapchainImages);\n","C","c","",[33],{"type":13,"tag":34,"props":35,"children":36},"code",{"__ignoreMap":31},[37,59,79,97,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},"    VkDevice ",{"type":13,"tag":38,"props":69,"children":71},{"style":70},"--shiki-default:#953800;--shiki-dark:#FFA657",[72],{"type":18,"value":73},"device",{"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},"    VkSwapchainKHR ",{"type":13,"tag":38,"props":89,"children":90},{"style":70},[91],{"type":18,"value":92},"swapchain",{"type":13,"tag":38,"props":94,"children":95},{"style":45},[96],{"type":18,"value":78},{"type":13,"tag":38,"props":98,"children":100},{"class":40,"line":99},4,[101,107,112],{"type":13,"tag":38,"props":102,"children":104},{"style":103},"--shiki-default:#CF222E;--shiki-dark:#FF7B72",[105],{"type":18,"value":106},"    uint32_t*",{"type":13,"tag":38,"props":108,"children":109},{"style":70},[110],{"type":18,"value":111}," pSwapchainImageCount",{"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},"    VkImage",{"type":13,"tag":38,"props":126,"children":127},{"style":103},[128],{"type":18,"value":129},"*",{"type":13,"tag":38,"props":131,"children":132},{"style":70},[133],{"type":18,"value":134}," pSwapchainImages",{"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_swapchain_images_khr(\n    device: crate :: vk :: vk::Device,\n    swapchain: vk::SwapchainKHR,\n    p_swapchain_image_count: *mut u32,\n    p_swapchain_images: *mut vk::Image,\n) -> vk::Result;\n","Rust","rs",[147],{"type":13,"tag":34,"props":148,"children":149},{"__ignoreMap":31},[150,172,223,252,278,311],{"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":103},[156],{"type":18,"value":157},"pub",{"type":13,"tag":38,"props":159,"children":160},{"style":103},[161],{"type":18,"value":162}," fn",{"type":13,"tag":38,"props":164,"children":165},{"style":51},[166],{"type":18,"value":167}," get_swapchain_images_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,205,210,214,219],{"type":13,"tag":38,"props":176,"children":177},{"style":45},[178],{"type":18,"value":179},"    device",{"type":13,"tag":38,"props":181,"children":182},{"style":103},[183],{"type":18,"value":184},":",{"type":13,"tag":38,"props":186,"children":187},{"style":103},[188],{"type":18,"value":189}," crate",{"type":13,"tag":38,"props":191,"children":192},{"style":103},[193],{"type":18,"value":194}," ::",{"type":13,"tag":38,"props":196,"children":197},{"style":45},[198],{"type":18,"value":199}," vk ",{"type":13,"tag":38,"props":201,"children":202},{"style":103},[203],{"type":18,"value":204},"::",{"type":13,"tag":38,"props":206,"children":207},{"style":70},[208],{"type":18,"value":209}," vk",{"type":13,"tag":38,"props":211,"children":212},{"style":103},[213],{"type":18,"value":204},{"type":13,"tag":38,"props":215,"children":216},{"style":70},[217],{"type":18,"value":218},"Device",{"type":13,"tag":38,"props":220,"children":221},{"style":45},[222],{"type":18,"value":78},{"type":13,"tag":38,"props":224,"children":225},{"class":40,"line":81},[226,231,235,239,243,248],{"type":13,"tag":38,"props":227,"children":228},{"style":45},[229],{"type":18,"value":230},"    swapchain",{"type":13,"tag":38,"props":232,"children":233},{"style":103},[234],{"type":18,"value":184},{"type":13,"tag":38,"props":236,"children":237},{"style":70},[238],{"type":18,"value":209},{"type":13,"tag":38,"props":240,"children":241},{"style":103},[242],{"type":18,"value":204},{"type":13,"tag":38,"props":244,"children":245},{"style":70},[246],{"type":18,"value":247},"SwapchainKHR",{"type":13,"tag":38,"props":249,"children":250},{"style":45},[251],{"type":18,"value":78},{"type":13,"tag":38,"props":253,"children":254},{"class":40,"line":99},[255,260,264,269,274],{"type":13,"tag":38,"props":256,"children":257},{"style":45},[258],{"type":18,"value":259},"    p_swapchain_image_count",{"type":13,"tag":38,"props":261,"children":262},{"style":103},[263],{"type":18,"value":184},{"type":13,"tag":38,"props":265,"children":266},{"style":103},[267],{"type":18,"value":268}," *mut",{"type":13,"tag":38,"props":270,"children":271},{"style":70},[272],{"type":18,"value":273}," u32",{"type":13,"tag":38,"props":275,"children":276},{"style":45},[277],{"type":18,"value":78},{"type":13,"tag":38,"props":279,"children":280},{"class":40,"line":118},[281,286,290,294,298,302,307],{"type":13,"tag":38,"props":282,"children":283},{"style":45},[284],{"type":18,"value":285},"    p_swapchain_images",{"type":13,"tag":38,"props":287,"children":288},{"style":103},[289],{"type":18,"value":184},{"type":13,"tag":38,"props":291,"children":292},{"style":103},[293],{"type":18,"value":268},{"type":13,"tag":38,"props":295,"children":296},{"style":70},[297],{"type":18,"value":209},{"type":13,"tag":38,"props":299,"children":300},{"style":103},[301],{"type":18,"value":204},{"type":13,"tag":38,"props":303,"children":304},{"style":70},[305],{"type":18,"value":306},"Image",{"type":13,"tag":38,"props":308,"children":309},{"style":45},[310],{"type":18,"value":78},{"type":13,"tag":38,"props":312,"children":314},{"class":40,"line":313},6,[315,320,325,329,333,338],{"type":13,"tag":38,"props":316,"children":317},{"style":45},[318],{"type":18,"value":319},") ",{"type":13,"tag":38,"props":321,"children":322},{"style":103},[323],{"type":18,"value":324},"->",{"type":13,"tag":38,"props":326,"children":327},{"style":70},[328],{"type":18,"value":209},{"type":13,"tag":38,"props":330,"children":331},{"style":103},[332],{"type":18,"value":204},{"type":13,"tag":38,"props":334,"children":335},{"style":70},[336],{"type":18,"value":337},"Result",{"type":13,"tag":38,"props":339,"children":340},{"style":45},[341],{"type":18,"value":342},";\n",{"type":13,"tag":344,"props":345,"children":346},"ul",{},[347,365,375,386],{"type":13,"tag":348,"props":349,"children":350},"li",{},[351,356,358,363],{"type":13,"tag":34,"props":352,"children":354},{"className":353},[],[355],{"type":18,"value":73},{"type":18,"value":357}," is the device associated with ",{"type":13,"tag":34,"props":359,"children":361},{"className":360},[],[362],{"type":18,"value":92},{"type":18,"value":364},".",{"type":13,"tag":348,"props":366,"children":367},{},[368,373],{"type":13,"tag":34,"props":369,"children":371},{"className":370},[],[372],{"type":18,"value":92},{"type":18,"value":374}," is the swapchain to query.",{"type":13,"tag":348,"props":376,"children":377},{},[378,384],{"type":13,"tag":34,"props":379,"children":381},{"className":380},[],[382],{"type":18,"value":383},"pSwapchainImageCount",{"type":18,"value":385}," is a pointer to an integer related to the\nnumber of presentable images available or queried, as described below.",{"type":13,"tag":348,"props":387,"children":388},{},[389,395,397,403,405,411],{"type":13,"tag":34,"props":390,"children":392},{"className":391},[],[393],{"type":18,"value":394},"pSwapchainImages",{"type":18,"value":396}," is either ",{"type":13,"tag":34,"props":398,"children":400},{"className":399},[],[401],{"type":18,"value":402},"NULL",{"type":18,"value":404}," or a pointer to an array of\n",{"type":13,"tag":34,"props":406,"children":408},{"className":407},[],[409],{"type":18,"value":410},"VkImage",{"type":18,"value":412}," handles.",{"type":13,"tag":14,"props":414,"children":415},{},[416,418,423,425,430,432,437,439,444,446,451,453,458,460,465,467,472,474,479,481,486,488,493,495,501,503,509],{"type":18,"value":417},"If ",{"type":13,"tag":34,"props":419,"children":421},{"className":420},[],[422],{"type":18,"value":394},{"type":18,"value":424}," is ",{"type":13,"tag":34,"props":426,"children":428},{"className":427},[],[429],{"type":18,"value":402},{"type":18,"value":431},", then the number of presentable images\nfor ",{"type":13,"tag":34,"props":433,"children":435},{"className":434},[],[436],{"type":18,"value":92},{"type":18,"value":438}," is returned in ",{"type":13,"tag":34,"props":440,"children":442},{"className":441},[],[443],{"type":18,"value":383},{"type":18,"value":445},".\nOtherwise, ",{"type":13,"tag":34,"props":447,"children":449},{"className":448},[],[450],{"type":18,"value":383},{"type":18,"value":452}," ",{"type":13,"tag":454,"props":455,"children":457},"normative",{"type":456},"must",[],{"type":18,"value":459}," point to a variable set by the\napplication to the number of elements in the ",{"type":13,"tag":34,"props":461,"children":463},{"className":462},[],[464],{"type":18,"value":394},{"type":18,"value":466}," array,\nand on return the variable is overwritten with the number of structures\nactually written to ",{"type":13,"tag":34,"props":468,"children":470},{"className":469},[],[471],{"type":18,"value":394},{"type":18,"value":473},".\nIf the value of ",{"type":13,"tag":34,"props":475,"children":477},{"className":476},[],[478],{"type":18,"value":383},{"type":18,"value":480}," is less than the number of\npresentable images for ",{"type":13,"tag":34,"props":482,"children":484},{"className":483},[],[485],{"type":18,"value":92},{"type":18,"value":487},", at most ",{"type":13,"tag":34,"props":489,"children":491},{"className":490},[],[492],{"type":18,"value":383},{"type":18,"value":494},"\nstructures will be written, and ",{"type":13,"tag":34,"props":496,"children":498},{"className":497},[],[499],{"type":18,"value":500},"VK_INCOMPLETE",{"type":18,"value":502}," will be returned instead\nof ",{"type":13,"tag":34,"props":504,"children":506},{"className":505},[],[507],{"type":18,"value":508},"VK_SUCCESS",{"type":18,"value":510},", to indicate that not all the available presentable\nimages were returned.",{"type":13,"tag":512,"props":513,"children":515},"validity-group",{"name":514},"Valid Usage (Implicit)",[516,544,568,594,655],{"type":13,"tag":517,"props":518,"children":520},"validity-field",{"name":519},"VUID-vkGetSwapchainImagesKHR-device-parameter",[521],{"type":13,"tag":14,"props":522,"children":523},{},[524,529,530,533,535,542],{"type":13,"tag":34,"props":525,"children":527},{"className":526},[],[528],{"type":18,"value":73},{"type":18,"value":452},{"type":13,"tag":454,"props":531,"children":532},{"type":456},[],{"type":18,"value":534}," be a valid ",{"type":13,"tag":536,"props":537,"children":539},"a",{"href":538},"/man/VkDevice",[540],{"type":18,"value":541},"VkDevice",{"type":18,"value":543}," handle",{"type":13,"tag":517,"props":545,"children":547},{"name":546},"VUID-vkGetSwapchainImagesKHR-swapchain-parameter",[548],{"type":13,"tag":14,"props":549,"children":550},{},[551,556,557,560,561,567],{"type":13,"tag":34,"props":552,"children":554},{"className":553},[],[555],{"type":18,"value":92},{"type":18,"value":452},{"type":13,"tag":454,"props":558,"children":559},{"type":456},[],{"type":18,"value":534},{"type":13,"tag":536,"props":562,"children":564},{"href":563},"/man/VkSwapchainKHR",[565],{"type":18,"value":566},"VkSwapchainKHR",{"type":18,"value":543},{"type":13,"tag":517,"props":569,"children":571},{"name":570},"VUID-vkGetSwapchainImagesKHR-pSwapchainImageCount-parameter",[572],{"type":13,"tag":14,"props":573,"children":574},{},[575,580,581,584,586,592],{"type":13,"tag":34,"props":576,"children":578},{"className":577},[],[579],{"type":18,"value":383},{"type":18,"value":452},{"type":13,"tag":454,"props":582,"children":583},{"type":456},[],{"type":18,"value":585}," be a valid pointer to a ",{"type":13,"tag":34,"props":587,"children":589},{"className":588},[],[590],{"type":18,"value":591},"uint32_t",{"type":18,"value":593}," value",{"type":13,"tag":517,"props":595,"children":597},{"name":596},"VUID-vkGetSwapchainImagesKHR-pSwapchainImages-parameter",[598],{"type":13,"tag":14,"props":599,"children":600},{},[601,603,608,610,616,618,623,624,629,631,636,637,640,642,647,648,653],{"type":18,"value":602},"If the value referenced by ",{"type":13,"tag":34,"props":604,"children":606},{"className":605},[],[607],{"type":18,"value":383},{"type":18,"value":609}," is not ",{"type":13,"tag":34,"props":611,"children":613},{"className":612},[],[614],{"type":18,"value":615},"0",{"type":18,"value":617},", and ",{"type":13,"tag":34,"props":619,"children":621},{"className":620},[],[622],{"type":18,"value":394},{"type":18,"value":609},{"type":13,"tag":34,"props":625,"children":627},{"className":626},[],[628],{"type":18,"value":402},{"type":18,"value":630},", ",{"type":13,"tag":34,"props":632,"children":634},{"className":633},[],[635],{"type":18,"value":394},{"type":18,"value":452},{"type":13,"tag":454,"props":638,"children":639},{"type":456},[],{"type":18,"value":641}," be a valid pointer to an array of ",{"type":13,"tag":34,"props":643,"children":645},{"className":644},[],[646],{"type":18,"value":383},{"type":18,"value":452},{"type":13,"tag":536,"props":649,"children":651},{"href":650},"/man/VkImage",[652],{"type":18,"value":410},{"type":18,"value":654}," handles",{"type":13,"tag":517,"props":656,"children":658},{"name":657},"VUID-vkGetSwapchainImagesKHR-swapchain-parent",[659],{"type":13,"tag":14,"props":660,"children":661},{},[662,667,668,671,673],{"type":13,"tag":34,"props":663,"children":665},{"className":664},[],[666],{"type":18,"value":92},{"type":18,"value":452},{"type":13,"tag":454,"props":669,"children":670},{"type":456},[],{"type":18,"value":672}," have been created, allocated, or retrieved from ",{"type":13,"tag":34,"props":674,"children":676},{"className":675},[],[677],{"type":18,"value":73},{"type":13,"tag":679,"props":680,"children":681},"style",{},[682],{"type":18,"value":683},"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":685},[],"markdown",1729612519108]