[{"data":1,"prerenderedAt":613},["ShallowReactive",2],{"vyqMiHI0Z1":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":612,"_id":4},"VkDisplayPresentInfoKHR","Structure describing parameters of a queue presentation to a swapchain","VK_KHR_display_swapchain","structs",[],{"type":10,"children":11,"toc":610},"root",[12,28,330,449,468,576,604],{"type":13,"tag":14,"props":15,"children":16},"element","p",{},[17,20,26],{"type":18,"value":19},"text","The ",{"type":13,"tag":21,"props":22,"children":24},"code",{"className":23},[],[25],{"type":18,"value":4},{"type":18,"value":27}," structure is defined as:",{"type":13,"tag":29,"props":30,"children":31},"code-group",{},[32,131],{"type":13,"tag":33,"props":34,"children":40},"pre",{"className":35,"code":36,"filename":37,"language":38,"meta":39,"style":39},"language-c shiki shiki-themes github-light-default github-dark-default","typedef struct VkDisplayPresentInfoKHR {\n    VkStructureType sType;\n    const void* pNext;\n    VkRect2D srcRect;\n    VkRect2D dstRect;\n    VkBool32 persistent;\n} VkDisplayPresentInfoKHR;\n","C","c","",[41],{"type":13,"tag":21,"props":42,"children":43},{"__ignoreMap":39},[44,67,76,95,104,113,122],{"type":13,"tag":45,"props":46,"children":49},"span",{"class":47,"line":48},"line",1,[50,56,61],{"type":13,"tag":45,"props":51,"children":53},{"style":52},"--shiki-default:#CF222E;--shiki-dark:#FF7B72",[54],{"type":18,"value":55},"typedef",{"type":13,"tag":45,"props":57,"children":58},{"style":52},[59],{"type":18,"value":60}," struct",{"type":13,"tag":45,"props":62,"children":64},{"style":63},"--shiki-default:#1F2328;--shiki-dark:#E6EDF3",[65],{"type":18,"value":66}," VkDisplayPresentInfoKHR {\n",{"type":13,"tag":45,"props":68,"children":70},{"class":47,"line":69},2,[71],{"type":13,"tag":45,"props":72,"children":73},{"style":63},[74],{"type":18,"value":75},"    VkStructureType sType;\n",{"type":13,"tag":45,"props":77,"children":79},{"class":47,"line":78},3,[80,85,90],{"type":13,"tag":45,"props":81,"children":82},{"style":52},[83],{"type":18,"value":84},"    const",{"type":13,"tag":45,"props":86,"children":87},{"style":52},[88],{"type":18,"value":89}," void*",{"type":13,"tag":45,"props":91,"children":92},{"style":63},[93],{"type":18,"value":94}," pNext;\n",{"type":13,"tag":45,"props":96,"children":98},{"class":47,"line":97},4,[99],{"type":13,"tag":45,"props":100,"children":101},{"style":63},[102],{"type":18,"value":103},"    VkRect2D srcRect;\n",{"type":13,"tag":45,"props":105,"children":107},{"class":47,"line":106},5,[108],{"type":13,"tag":45,"props":109,"children":110},{"style":63},[111],{"type":18,"value":112},"    VkRect2D dstRect;\n",{"type":13,"tag":45,"props":114,"children":116},{"class":47,"line":115},6,[117],{"type":13,"tag":45,"props":118,"children":119},{"style":63},[120],{"type":18,"value":121},"    VkBool32 persistent;\n",{"type":13,"tag":45,"props":123,"children":125},{"class":47,"line":124},7,[126],{"type":13,"tag":45,"props":127,"children":128},{"style":63},[129],{"type":18,"value":130},"} VkDisplayPresentInfoKHR;\n",{"type":13,"tag":33,"props":132,"children":137},{"className":133,"code":134,"filename":135,"language":136,"meta":39,"style":39},"language-rs shiki shiki-themes github-light-default github-dark-default","pub struct DisplayPresentInfoKHR {\n    s_type: vk::StructureType,\n    p_next: *const c_void,\n    src_rect: vk::Rect2D, // Rectangle within the presentable image to read pixel data from when presenting to the display.\n    dst_rect: vk::Rect2D, // Rectangle within the current display mode's visible region to display srcRectangle in.\n    persistent: vk::Bool32, // For smart displays, use buffered mode.  If the display properties member \"persistentMode\" is VK_FALSE, this member must always be VK_FALSE.\n}\n","Rust","rs",[138],{"type":13,"tag":21,"props":139,"children":140},{"__ignoreMap":39},[141,164,197,219,255,288,322],{"type":13,"tag":45,"props":142,"children":143},{"class":47,"line":48},[144,149,153,159],{"type":13,"tag":45,"props":145,"children":146},{"style":52},[147],{"type":18,"value":148},"pub",{"type":13,"tag":45,"props":150,"children":151},{"style":52},[152],{"type":18,"value":60},{"type":13,"tag":45,"props":154,"children":156},{"style":155},"--shiki-default:#953800;--shiki-dark:#FFA657",[157],{"type":18,"value":158}," DisplayPresentInfoKHR",{"type":13,"tag":45,"props":160,"children":161},{"style":63},[162],{"type":18,"value":163}," {\n",{"type":13,"tag":45,"props":165,"children":166},{"class":47,"line":69},[167,172,177,182,187,192],{"type":13,"tag":45,"props":168,"children":169},{"style":63},[170],{"type":18,"value":171},"    s_type",{"type":13,"tag":45,"props":173,"children":174},{"style":52},[175],{"type":18,"value":176},":",{"type":13,"tag":45,"props":178,"children":179},{"style":155},[180],{"type":18,"value":181}," vk",{"type":13,"tag":45,"props":183,"children":184},{"style":52},[185],{"type":18,"value":186},"::",{"type":13,"tag":45,"props":188,"children":189},{"style":155},[190],{"type":18,"value":191},"StructureType",{"type":13,"tag":45,"props":193,"children":194},{"style":63},[195],{"type":18,"value":196},",\n",{"type":13,"tag":45,"props":198,"children":199},{"class":47,"line":78},[200,205,209,214],{"type":13,"tag":45,"props":201,"children":202},{"style":63},[203],{"type":18,"value":204},"    p_next",{"type":13,"tag":45,"props":206,"children":207},{"style":52},[208],{"type":18,"value":176},{"type":13,"tag":45,"props":210,"children":211},{"style":52},[212],{"type":18,"value":213}," *const",{"type":13,"tag":45,"props":215,"children":216},{"style":63},[217],{"type":18,"value":218}," c_void,\n",{"type":13,"tag":45,"props":220,"children":221},{"class":47,"line":97},[222,227,231,235,239,244,249],{"type":13,"tag":45,"props":223,"children":224},{"style":63},[225],{"type":18,"value":226},"    src_rect",{"type":13,"tag":45,"props":228,"children":229},{"style":52},[230],{"type":18,"value":176},{"type":13,"tag":45,"props":232,"children":233},{"style":155},[234],{"type":18,"value":181},{"type":13,"tag":45,"props":236,"children":237},{"style":52},[238],{"type":18,"value":186},{"type":13,"tag":45,"props":240,"children":241},{"style":155},[242],{"type":18,"value":243},"Rect2D",{"type":13,"tag":45,"props":245,"children":246},{"style":63},[247],{"type":18,"value":248},", ",{"type":13,"tag":45,"props":250,"children":252},{"style":251},"--shiki-default:#6E7781;--shiki-dark:#8B949E",[253],{"type":18,"value":254},"// Rectangle within the presentable image to read pixel data from when presenting to the display.\n",{"type":13,"tag":45,"props":256,"children":257},{"class":47,"line":106},[258,263,267,271,275,279,283],{"type":13,"tag":45,"props":259,"children":260},{"style":63},[261],{"type":18,"value":262},"    dst_rect",{"type":13,"tag":45,"props":264,"children":265},{"style":52},[266],{"type":18,"value":176},{"type":13,"tag":45,"props":268,"children":269},{"style":155},[270],{"type":18,"value":181},{"type":13,"tag":45,"props":272,"children":273},{"style":52},[274],{"type":18,"value":186},{"type":13,"tag":45,"props":276,"children":277},{"style":155},[278],{"type":18,"value":243},{"type":13,"tag":45,"props":280,"children":281},{"style":63},[282],{"type":18,"value":248},{"type":13,"tag":45,"props":284,"children":285},{"style":251},[286],{"type":18,"value":287},"// Rectangle within the current display mode's visible region to display srcRectangle in.\n",{"type":13,"tag":45,"props":289,"children":290},{"class":47,"line":115},[291,296,300,304,308,313,317],{"type":13,"tag":45,"props":292,"children":293},{"style":63},[294],{"type":18,"value":295},"    persistent",{"type":13,"tag":45,"props":297,"children":298},{"style":52},[299],{"type":18,"value":176},{"type":13,"tag":45,"props":301,"children":302},{"style":155},[303],{"type":18,"value":181},{"type":13,"tag":45,"props":305,"children":306},{"style":52},[307],{"type":18,"value":186},{"type":13,"tag":45,"props":309,"children":310},{"style":155},[311],{"type":18,"value":312},"Bool32",{"type":13,"tag":45,"props":314,"children":315},{"style":63},[316],{"type":18,"value":248},{"type":13,"tag":45,"props":318,"children":319},{"style":251},[320],{"type":18,"value":321},"// For smart displays, use buffered mode.  If the display properties member \"persistentMode\" is VK_FALSE, this member must always be VK_FALSE.\n",{"type":13,"tag":45,"props":323,"children":324},{"class":47,"line":124},[325],{"type":13,"tag":45,"props":326,"children":327},{"style":63},[328],{"type":18,"value":329},"}\n",{"type":13,"tag":331,"props":332,"children":333},"ul",{},[334,355,374,399,417],{"type":13,"tag":335,"props":336,"children":337},"li",{},[338,344,346,353],{"type":13,"tag":21,"props":339,"children":341},{"className":340},[],[342],{"type":18,"value":343},"sType",{"type":18,"value":345}," is a ",{"type":13,"tag":347,"props":348,"children":350},"a",{"href":349},"/man/VkStructureType",[351],{"type":18,"value":352},"VkStructureType",{"type":18,"value":354}," value identifying this structure.",{"type":13,"tag":335,"props":356,"children":357},{},[358,364,366,372],{"type":13,"tag":21,"props":359,"children":361},{"className":360},[],[362],{"type":18,"value":363},"pNext",{"type":18,"value":365}," is ",{"type":13,"tag":21,"props":367,"children":369},{"className":368},[],[370],{"type":18,"value":371},"NULL",{"type":18,"value":373}," or a pointer to a structure extending this\nstructure.",{"type":13,"tag":335,"props":375,"children":376},{},[377,383,385,390,392,397],{"type":13,"tag":21,"props":378,"children":380},{"className":379},[],[381],{"type":18,"value":382},"srcRect",{"type":18,"value":384}," is a rectangular region of pixels to present.\nIt ",{"type":13,"tag":386,"props":387,"children":389},"normative",{"type":388},"must",[],{"type":18,"value":391}," be a subset of the image being presented.\nIf ",{"type":13,"tag":21,"props":393,"children":395},{"className":394},[],[396],{"type":18,"value":4},{"type":18,"value":398}," is not specified, this region will be\nassumed to be the entire presentable image.",{"type":13,"tag":335,"props":400,"children":401},{},[402,408,410,415],{"type":13,"tag":21,"props":403,"children":405},{"className":404},[],[406],{"type":18,"value":407},"dstRect",{"type":18,"value":409}," is a rectangular region within the visible region of the\nswapchain’s display mode.\nIf ",{"type":13,"tag":21,"props":411,"children":413},{"className":412},[],[414],{"type":18,"value":4},{"type":18,"value":416}," is not specified, this region will be\nassumed to be the entire visible region of the swapchain’s mode.\nIf the specified rectangle is a subset of the display mode’s visible\nregion, content from display planes below the swapchain’s plane will be\nvisible outside the rectangle.\nIf there are no planes below the swapchain’s, the area outside the\nspecified rectangle will be black.\nIf portions of the specified rectangle are outside of the display’s\nvisible region, pixels mapping only to those portions of the rectangle\nwill be discarded.",{"type":13,"tag":335,"props":418,"children":419},{},[420,426,428,434,436,440,442,447],{"type":13,"tag":21,"props":421,"children":423},{"className":422},[],[424],{"type":18,"value":425},"persistent",{"type":18,"value":427},": If this is ",{"type":13,"tag":21,"props":429,"children":431},{"className":430},[],[432],{"type":18,"value":433},"VK_TRUE",{"type":18,"value":435},", the display engine will\nenable buffered mode on displays that support it.\nThis allows the display engine to stop sending content to the display\nuntil a new image is presented.\nThe display will instead maintain a copy of the last presented image.\nThis allows less power to be used, but ",{"type":13,"tag":386,"props":437,"children":439},{"type":438},"may",[],{"type":18,"value":441}," increase presentation\nlatency.\nIf ",{"type":13,"tag":21,"props":443,"children":445},{"className":444},[],[446],{"type":18,"value":4},{"type":18,"value":448}," is not specified, persistent mode will\nnot be used.",{"type":13,"tag":14,"props":450,"children":451},{},[452,454,459,461,466],{"type":18,"value":453},"If the extent of the ",{"type":13,"tag":21,"props":455,"children":457},{"className":456},[],[458],{"type":18,"value":382},{"type":18,"value":460}," and ",{"type":13,"tag":21,"props":462,"children":464},{"className":463},[],[465],{"type":18,"value":407},{"type":18,"value":467}," are not equal, the\npresented pixels will be scaled accordingly.",{"type":13,"tag":469,"props":470,"children":472},"validity-group",{"name":471},"Valid Usage",[473,493,519],{"type":13,"tag":474,"props":475,"children":477},"validity-field",{"name":476},"VUID-VkDisplayPresentInfoKHR-srcRect-01257",[478],{"type":13,"tag":14,"props":479,"children":480},{},[481,486,488,491],{"type":13,"tag":21,"props":482,"children":484},{"className":483},[],[485],{"type":18,"value":382},{"type":18,"value":487}," ",{"type":13,"tag":386,"props":489,"children":490},{"type":388},[],{"type":18,"value":492}," specify a rectangular region that is a subset of the\nimage being presented",{"type":13,"tag":474,"props":494,"children":496},{"name":495},"VUID-VkDisplayPresentInfoKHR-dstRect-01258",[497],{"type":13,"tag":14,"props":498,"children":499},{},[500,505,506,509,511,517],{"type":13,"tag":21,"props":501,"children":503},{"className":502},[],[504],{"type":18,"value":407},{"type":18,"value":487},{"type":13,"tag":386,"props":507,"children":508},{"type":388},[],{"type":18,"value":510}," specify a rectangular region that is a subset of the\n",{"type":13,"tag":21,"props":512,"children":514},{"className":513},[],[515],{"type":18,"value":516},"visibleRegion",{"type":18,"value":518}," parameter of the display mode the swapchain being\npresented uses",{"type":13,"tag":474,"props":520,"children":522},{"name":521},"VUID-VkDisplayPresentInfoKHR-persistentContent-01259",[523],{"type":13,"tag":14,"props":524,"children":525},{},[526,528,534,536,542,544,550,552,558,560,565,566,569,571],{"type":18,"value":527},"If the ",{"type":13,"tag":21,"props":529,"children":531},{"className":530},[],[532],{"type":18,"value":533},"persistentContent",{"type":18,"value":535}," member of the\n",{"type":13,"tag":21,"props":537,"children":539},{"className":538},[],[540],{"type":18,"value":541},"VkDisplayPropertiesKHR",{"type":18,"value":543}," structure returned by\n",{"type":13,"tag":21,"props":545,"children":547},{"className":546},[],[548],{"type":18,"value":549},"vkGetPhysicalDeviceDisplayPropertiesKHR",{"type":18,"value":551}," for the display the\npresent operation targets is ",{"type":13,"tag":21,"props":553,"children":555},{"className":554},[],[556],{"type":18,"value":557},"VK_FALSE",{"type":18,"value":559},", then ",{"type":13,"tag":21,"props":561,"children":563},{"className":562},[],[564],{"type":18,"value":425},{"type":18,"value":487},{"type":13,"tag":386,"props":567,"children":568},{"type":388},[],{"type":18,"value":570},"\nbe ",{"type":13,"tag":21,"props":572,"children":574},{"className":573},[],[575],{"type":18,"value":557},{"type":13,"tag":469,"props":577,"children":579},{"name":578},"Valid Usage (Implicit)",[580],{"type":13,"tag":474,"props":581,"children":583},{"name":582},"VUID-VkDisplayPresentInfoKHR-sType-sType",[584],{"type":13,"tag":14,"props":585,"children":586},{},[587,592,593,596,598],{"type":13,"tag":21,"props":588,"children":590},{"className":589},[],[591],{"type":18,"value":343},{"type":18,"value":487},{"type":13,"tag":386,"props":594,"children":595},{"type":388},[],{"type":18,"value":597}," be ",{"type":13,"tag":21,"props":599,"children":601},{"className":600},[],[602],{"type":18,"value":603},"VK_STRUCTURE_TYPE_DISPLAY_PRESENT_INFO_KHR",{"type":13,"tag":605,"props":606,"children":607},"style",{},[608],{"type":18,"value":609},"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":39,"searchDepth":69,"depth":69,"links":611},[],"markdown",1729612445889]