[{"data":1,"prerenderedAt":734},["ShallowReactive",2],{"gN6rEKfVX2":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":733,"_id":4},"vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR","Reports properties of the performance query counters available on a queue family of a device","VK_KHR_performance_query","protos",[],{"type":10,"children":11,"toc":731},"root",[12,20,370,458,554,725],{"type":13,"tag":14,"props":15,"children":16},"element","p",{},[17],{"type":18,"value":19},"text","To enumerate the performance query counters available on a queue family of a\nphysical device, call:",{"type":13,"tag":21,"props":22,"children":23},"code-group",{},[24,162],{"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 vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR(\n VkPhysicalDevice physicalDevice,\n uint32_t queueFamilyIndex,\n uint32_t* pCounterCount,\n VkPerformanceCounterKHR* pCounters,\n VkPerformanceCounterDescriptionKHR* pCounterDescriptions);\n","C","c","",[33],{"type":13,"tag":34,"props":35,"children":36},"code",{"__ignoreMap":31},[37,59,79,98,116,139],{"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}," queueFamilyIndex",{"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}," pCounterCount",{"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}," VkPerformanceCounterKHR",{"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}," pCounters",{"type":13,"tag":38,"props":136,"children":137},{"style":45},[138],{"type":18,"value":78},{"type":13,"tag":38,"props":140,"children":142},{"class":40,"line":141},6,[143,148,152,157],{"type":13,"tag":38,"props":144,"children":145},{"style":45},[146],{"type":18,"value":147}," VkPerformanceCounterDescriptionKHR",{"type":13,"tag":38,"props":149,"children":150},{"style":85},[151],{"type":18,"value":129},{"type":13,"tag":38,"props":153,"children":154},{"style":70},[155],{"type":18,"value":156}," pCounterDescriptions",{"type":13,"tag":38,"props":158,"children":159},{"style":45},[160],{"type":18,"value":161},");\n",{"type":13,"tag":25,"props":163,"children":168},{"className":164,"code":165,"filename":166,"language":167,"meta":31,"style":31},"language-rs shiki shiki-themes github-light-default github-dark-default","pub fn enumerate_physical_device_queue_family_performance_query_counters_khr(\n physical_device: vk::PhysicalDevice,\n queue_family_index: u32,\n p_counter_count: *mut u32,\n p_counters: *mut vk::PerformanceCounterKHR,\n p_counter_descriptions: *mut vk::PerformanceCounterDescriptionKHR,\n) -> vk::Result;\n","Rust","rs",[169],{"type":13,"tag":34,"props":170,"children":171},{"__ignoreMap":31},[172,194,226,247,272,305,338],{"type":13,"tag":38,"props":173,"children":174},{"class":40,"line":41},[175,180,185,190],{"type":13,"tag":38,"props":176,"children":177},{"style":85},[178],{"type":18,"value":179},"pub",{"type":13,"tag":38,"props":181,"children":182},{"style":85},[183],{"type":18,"value":184}," fn",{"type":13,"tag":38,"props":186,"children":187},{"style":51},[188],{"type":18,"value":189}," enumerate_physical_device_queue_family_performance_query_counters_khr",{"type":13,"tag":38,"props":191,"children":192},{"style":45},[193],{"type":18,"value":58},{"type":13,"tag":38,"props":195,"children":196},{"class":40,"line":61},[197,202,207,212,217,222],{"type":13,"tag":38,"props":198,"children":199},{"style":45},[200],{"type":18,"value":201}," physical_device",{"type":13,"tag":38,"props":203,"children":204},{"style":85},[205],{"type":18,"value":206},":",{"type":13,"tag":38,"props":208,"children":209},{"style":70},[210],{"type":18,"value":211}," vk",{"type":13,"tag":38,"props":213,"children":214},{"style":85},[215],{"type":18,"value":216},"::",{"type":13,"tag":38,"props":218,"children":219},{"style":70},[220],{"type":18,"value":221},"PhysicalDevice",{"type":13,"tag":38,"props":223,"children":224},{"style":45},[225],{"type":18,"value":78},{"type":13,"tag":38,"props":227,"children":228},{"class":40,"line":81},[229,234,238,243],{"type":13,"tag":38,"props":230,"children":231},{"style":45},[232],{"type":18,"value":233}," queue_family_index",{"type":13,"tag":38,"props":235,"children":236},{"style":85},[237],{"type":18,"value":206},{"type":13,"tag":38,"props":239,"children":240},{"style":70},[241],{"type":18,"value":242}," u32",{"type":13,"tag":38,"props":244,"children":245},{"style":45},[246],{"type":18,"value":78},{"type":13,"tag":38,"props":248,"children":249},{"class":40,"line":100},[250,255,259,264,268],{"type":13,"tag":38,"props":251,"children":252},{"style":45},[253],{"type":18,"value":254}," p_counter_count",{"type":13,"tag":38,"props":256,"children":257},{"style":85},[258],{"type":18,"value":206},{"type":13,"tag":38,"props":260,"children":261},{"style":85},[262],{"type":18,"value":263}," *mut",{"type":13,"tag":38,"props":265,"children":266},{"style":70},[267],{"type":18,"value":242},{"type":13,"tag":38,"props":269,"children":270},{"style":45},[271],{"type":18,"value":78},{"type":13,"tag":38,"props":273,"children":274},{"class":40,"line":118},[275,280,284,288,292,296,301],{"type":13,"tag":38,"props":276,"children":277},{"style":45},[278],{"type":18,"value":279}," p_counters",{"type":13,"tag":38,"props":281,"children":282},{"style":85},[283],{"type":18,"value":206},{"type":13,"tag":38,"props":285,"children":286},{"style":85},[287],{"type":18,"value":263},{"type":13,"tag":38,"props":289,"children":290},{"style":70},[291],{"type":18,"value":211},{"type":13,"tag":38,"props":293,"children":294},{"style":85},[295],{"type":18,"value":216},{"type":13,"tag":38,"props":297,"children":298},{"style":70},[299],{"type":18,"value":300},"PerformanceCounterKHR",{"type":13,"tag":38,"props":302,"children":303},{"style":45},[304],{"type":18,"value":78},{"type":13,"tag":38,"props":306,"children":307},{"class":40,"line":141},[308,313,317,321,325,329,334],{"type":13,"tag":38,"props":309,"children":310},{"style":45},[311],{"type":18,"value":312}," p_counter_descriptions",{"type":13,"tag":38,"props":314,"children":315},{"style":85},[316],{"type":18,"value":206},{"type":13,"tag":38,"props":318,"children":319},{"style":85},[320],{"type":18,"value":263},{"type":13,"tag":38,"props":322,"children":323},{"style":70},[324],{"type":18,"value":211},{"type":13,"tag":38,"props":326,"children":327},{"style":85},[328],{"type":18,"value":216},{"type":13,"tag":38,"props":330,"children":331},{"style":70},[332],{"type":18,"value":333},"PerformanceCounterDescriptionKHR",{"type":13,"tag":38,"props":335,"children":336},{"style":45},[337],{"type":18,"value":78},{"type":13,"tag":38,"props":339,"children":341},{"class":40,"line":340},7,[342,347,352,356,360,365],{"type":13,"tag":38,"props":343,"children":344},{"style":45},[345],{"type":18,"value":346},") ",{"type":13,"tag":38,"props":348,"children":349},{"style":85},[350],{"type":18,"value":351},"->",{"type":13,"tag":38,"props":353,"children":354},{"style":70},[355],{"type":18,"value":211},{"type":13,"tag":38,"props":357,"children":358},{"style":85},[359],{"type":18,"value":216},{"type":13,"tag":38,"props":361,"children":362},{"style":70},[363],{"type":18,"value":364},"Result",{"type":13,"tag":38,"props":366,"children":367},{"style":45},[368],{"type":18,"value":369},";\n",{"type":13,"tag":371,"props":372,"children":373},"ul",{},[374,385,396,407,435],{"type":13,"tag":375,"props":376,"children":377},"li",{},[378,383],{"type":13,"tag":34,"props":379,"children":381},{"className":380},[],[382],{"type":18,"value":73},{"type":18,"value":384}," is the handle to the physical device whose queue\nfamily performance query counter properties will be queried.",{"type":13,"tag":375,"props":386,"children":387},{},[388,394],{"type":13,"tag":34,"props":389,"children":391},{"className":390},[],[392],{"type":18,"value":393},"queueFamilyIndex",{"type":18,"value":395}," is the index into the queue family of the\nphysical device we want to get properties for.",{"type":13,"tag":375,"props":397,"children":398},{},[399,405],{"type":13,"tag":34,"props":400,"children":402},{"className":401},[],[403],{"type":18,"value":404},"pCounterCount",{"type":18,"value":406}," is a pointer to an integer related to the number of\ncounters available or queried, as described below.",{"type":13,"tag":375,"props":408,"children":409},{},[410,416,418,424,426,433],{"type":13,"tag":34,"props":411,"children":413},{"className":412},[],[414],{"type":18,"value":415},"pCounters",{"type":18,"value":417}," is either ",{"type":13,"tag":34,"props":419,"children":421},{"className":420},[],[422],{"type":18,"value":423},"NULL",{"type":18,"value":425}," or a pointer to an array of\n",{"type":13,"tag":427,"props":428,"children":430},"a",{"href":429},"/man/VkPerformanceCounterKHR",[431],{"type":18,"value":432},"VkPerformanceCounterKHR",{"type":18,"value":434}," structures.",{"type":13,"tag":375,"props":436,"children":437},{},[438,444,445,450,451,457],{"type":13,"tag":34,"props":439,"children":441},{"className":440},[],[442],{"type":18,"value":443},"pCounterDescriptions",{"type":18,"value":417},{"type":13,"tag":34,"props":446,"children":448},{"className":447},[],[449],{"type":18,"value":423},{"type":18,"value":425},{"type":13,"tag":427,"props":452,"children":454},{"href":453},"/man/VkPerformanceCounterDescriptionKHR",[455],{"type":18,"value":456},"VkPerformanceCounterDescriptionKHR",{"type":18,"value":434},{"type":13,"tag":14,"props":459,"children":460},{},[461,463,468,470,475,477,482,483,488,490,495,497,502,504,509,511,516,517,522,524,529,531,536,538,544,546,552],{"type":18,"value":462},"If ",{"type":13,"tag":34,"props":464,"children":466},{"className":465},[],[467],{"type":18,"value":415},{"type":18,"value":469}," is ",{"type":13,"tag":34,"props":471,"children":473},{"className":472},[],[474],{"type":18,"value":423},{"type":18,"value":476}," and ",{"type":13,"tag":34,"props":478,"children":480},{"className":479},[],[481],{"type":18,"value":443},{"type":18,"value":469},{"type":13,"tag":34,"props":484,"children":486},{"className":485},[],[487],{"type":18,"value":423},{"type":18,"value":489},", then\nthe number of counters available is returned in ",{"type":13,"tag":34,"props":491,"children":493},{"className":492},[],[494],{"type":18,"value":404},{"type":18,"value":496},".\nOtherwise, ",{"type":13,"tag":34,"props":498,"children":500},{"className":499},[],[501],{"type":18,"value":404},{"type":18,"value":503}," ",{"type":13,"tag":505,"props":506,"children":508},"normative",{"type":507},"must",[],{"type":18,"value":510}," point to a variable set by the\napplication to the number of elements in the ",{"type":13,"tag":34,"props":512,"children":514},{"className":513},[],[515],{"type":18,"value":415},{"type":18,"value":78},{"type":13,"tag":34,"props":518,"children":520},{"className":519},[],[521],{"type":18,"value":443},{"type":18,"value":523},", or both arrays and on return the variable is\noverwritten with the number of structures actually written out.\nIf ",{"type":13,"tag":34,"props":525,"children":527},{"className":526},[],[528],{"type":18,"value":404},{"type":18,"value":530}," is less than the number of counters available, at\nmost ",{"type":13,"tag":34,"props":532,"children":534},{"className":533},[],[535],{"type":18,"value":404},{"type":18,"value":537}," structures will be written, and ",{"type":13,"tag":34,"props":539,"children":541},{"className":540},[],[542],{"type":18,"value":543},"VK_INCOMPLETE",{"type":18,"value":545},"\nwill be returned instead of ",{"type":13,"tag":34,"props":547,"children":549},{"className":548},[],[550],{"type":18,"value":551},"VK_SUCCESS",{"type":18,"value":553},", to indicate that not all the\navailable counters were returned.",{"type":13,"tag":555,"props":556,"children":558},"validity-group",{"name":557},"Valid Usage (Implicit)",[559,586,612,672],{"type":13,"tag":560,"props":561,"children":563},"validity-field",{"name":562},"VUID-vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR-physicalDevice-parameter",[564],{"type":13,"tag":14,"props":565,"children":566},{},[567,572,573,576,578,584],{"type":13,"tag":34,"props":568,"children":570},{"className":569},[],[571],{"type":18,"value":73},{"type":18,"value":503},{"type":13,"tag":505,"props":574,"children":575},{"type":507},[],{"type":18,"value":577}," be a valid ",{"type":13,"tag":427,"props":579,"children":581},{"href":580},"/man/VkPhysicalDevice",[582],{"type":18,"value":583},"VkPhysicalDevice",{"type":18,"value":585}," handle",{"type":13,"tag":560,"props":587,"children":589},{"name":588},"VUID-vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR-pCounterCount-parameter",[590],{"type":13,"tag":14,"props":591,"children":592},{},[593,598,599,602,604,610],{"type":13,"tag":34,"props":594,"children":596},{"className":595},[],[597],{"type":18,"value":404},{"type":18,"value":503},{"type":13,"tag":505,"props":600,"children":601},{"type":507},[],{"type":18,"value":603}," be a valid pointer to a ",{"type":13,"tag":34,"props":605,"children":607},{"className":606},[],[608],{"type":18,"value":609},"uint32_t",{"type":18,"value":611}," value",{"type":13,"tag":560,"props":613,"children":615},{"name":614},"VUID-vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR-pCounters-parameter",[616],{"type":13,"tag":14,"props":617,"children":618},{},[619,621,626,628,634,636,641,642,647,649,654,655,658,660,665,666,670],{"type":18,"value":620},"If the value referenced by ",{"type":13,"tag":34,"props":622,"children":624},{"className":623},[],[625],{"type":18,"value":404},{"type":18,"value":627}," is not ",{"type":13,"tag":34,"props":629,"children":631},{"className":630},[],[632],{"type":18,"value":633},"0",{"type":18,"value":635},", and ",{"type":13,"tag":34,"props":637,"children":639},{"className":638},[],[640],{"type":18,"value":415},{"type":18,"value":627},{"type":13,"tag":34,"props":643,"children":645},{"className":644},[],[646],{"type":18,"value":423},{"type":18,"value":648},", ",{"type":13,"tag":34,"props":650,"children":652},{"className":651},[],[653],{"type":18,"value":415},{"type":18,"value":503},{"type":13,"tag":505,"props":656,"children":657},{"type":507},[],{"type":18,"value":659}," be a valid pointer to an array of ",{"type":13,"tag":34,"props":661,"children":663},{"className":662},[],[664],{"type":18,"value":404},{"type":18,"value":503},{"type":13,"tag":427,"props":667,"children":668},{"href":429},[669],{"type":18,"value":432},{"type":18,"value":671}," structures",{"type":13,"tag":560,"props":673,"children":675},{"name":674},"VUID-vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR-pCounterDescriptions-parameter",[676],{"type":13,"tag":14,"props":677,"children":678},{},[679,680,685,686,691,692,697,698,703,704,709,710,713,714,719,720,724],{"type":18,"value":620},{"type":13,"tag":34,"props":681,"children":683},{"className":682},[],[684],{"type":18,"value":404},{"type":18,"value":627},{"type":13,"tag":34,"props":687,"children":689},{"className":688},[],[690],{"type":18,"value":633},{"type":18,"value":635},{"type":13,"tag":34,"props":693,"children":695},{"className":694},[],[696],{"type":18,"value":443},{"type":18,"value":627},{"type":13,"tag":34,"props":699,"children":701},{"className":700},[],[702],{"type":18,"value":423},{"type":18,"value":648},{"type":13,"tag":34,"props":705,"children":707},{"className":706},[],[708],{"type":18,"value":443},{"type":18,"value":503},{"type":13,"tag":505,"props":711,"children":712},{"type":507},[],{"type":18,"value":659},{"type":13,"tag":34,"props":715,"children":717},{"className":716},[],[718],{"type":18,"value":404},{"type":18,"value":503},{"type":13,"tag":427,"props":721,"children":722},{"href":453},[723],{"type":18,"value":456},{"type":18,"value":671},{"type":13,"tag":726,"props":727,"children":728},"style",{},[729],{"type":18,"value":730},"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":732},[],"markdown",1725732616338]