[{"data":1,"prerenderedAt":769},["ShallowReactive",2],{"a9RaGVTUuW":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":768,"_id":4},"vkGetPipelineBinaryDataKHR","Get the data store from a pipeline binary","VK_KHR_pipeline_binary","protos",[],{"type":10,"children":11,"toc":766},"root",[12,27,403,493,576,602,760],{"type":13,"tag":14,"props":15,"children":16},"element","p",{},[17,20,25],{"type":18,"value":19},"text","Data ",{"type":13,"tag":21,"props":22,"children":24},"normative",{"type":23},"can",[],{"type":18,"value":26}," be retrieved from a pipeline binary object using the command:",{"type":13,"tag":28,"props":29,"children":30},"code-group",{},[31,174],{"type":13,"tag":32,"props":33,"children":39},"pre",{"className":34,"code":35,"filename":36,"language":37,"meta":38,"style":38},"language-c shiki shiki-themes github-light-default github-dark-default","VkResult vkGetPipelineBinaryDataKHR(\n    VkDevice device,\n    const VkPipelineBinaryDataInfoKHR* pInfo,\n    VkPipelineBinaryKeyKHR* pPipelineBinaryKey,\n    size_t* pPipelineBinaryDataSize,\n    void* pPipelineBinaryData);\n","C","c","",[40],{"type":13,"tag":41,"props":42,"children":43},"code",{"__ignoreMap":38},[44,66,86,115,137,155],{"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:#1F2328;--shiki-dark:#E6EDF3",[54],{"type":18,"value":55},"VkResult ",{"type":13,"tag":45,"props":57,"children":59},{"style":58},"--shiki-default:#8250DF;--shiki-dark:#D2A8FF",[60],{"type":18,"value":4},{"type":13,"tag":45,"props":62,"children":63},{"style":52},[64],{"type":18,"value":65},"(\n",{"type":13,"tag":45,"props":67,"children":69},{"class":47,"line":68},2,[70,75,81],{"type":13,"tag":45,"props":71,"children":72},{"style":52},[73],{"type":18,"value":74},"    VkDevice ",{"type":13,"tag":45,"props":76,"children":78},{"style":77},"--shiki-default:#953800;--shiki-dark:#FFA657",[79],{"type":18,"value":80},"device",{"type":13,"tag":45,"props":82,"children":83},{"style":52},[84],{"type":18,"value":85},",\n",{"type":13,"tag":45,"props":87,"children":89},{"class":47,"line":88},3,[90,96,101,106,111],{"type":13,"tag":45,"props":91,"children":93},{"style":92},"--shiki-default:#CF222E;--shiki-dark:#FF7B72",[94],{"type":18,"value":95},"    const",{"type":13,"tag":45,"props":97,"children":98},{"style":52},[99],{"type":18,"value":100}," VkPipelineBinaryDataInfoKHR",{"type":13,"tag":45,"props":102,"children":103},{"style":92},[104],{"type":18,"value":105},"*",{"type":13,"tag":45,"props":107,"children":108},{"style":77},[109],{"type":18,"value":110}," pInfo",{"type":13,"tag":45,"props":112,"children":113},{"style":52},[114],{"type":18,"value":85},{"type":13,"tag":45,"props":116,"children":118},{"class":47,"line":117},4,[119,124,128,133],{"type":13,"tag":45,"props":120,"children":121},{"style":52},[122],{"type":18,"value":123},"    VkPipelineBinaryKeyKHR",{"type":13,"tag":45,"props":125,"children":126},{"style":92},[127],{"type":18,"value":105},{"type":13,"tag":45,"props":129,"children":130},{"style":77},[131],{"type":18,"value":132}," pPipelineBinaryKey",{"type":13,"tag":45,"props":134,"children":135},{"style":52},[136],{"type":18,"value":85},{"type":13,"tag":45,"props":138,"children":140},{"class":47,"line":139},5,[141,146,151],{"type":13,"tag":45,"props":142,"children":143},{"style":92},[144],{"type":18,"value":145},"    size_t*",{"type":13,"tag":45,"props":147,"children":148},{"style":77},[149],{"type":18,"value":150}," pPipelineBinaryDataSize",{"type":13,"tag":45,"props":152,"children":153},{"style":52},[154],{"type":18,"value":85},{"type":13,"tag":45,"props":156,"children":158},{"class":47,"line":157},6,[159,164,169],{"type":13,"tag":45,"props":160,"children":161},{"style":92},[162],{"type":18,"value":163},"    void*",{"type":13,"tag":45,"props":165,"children":166},{"style":77},[167],{"type":18,"value":168}," pPipelineBinaryData",{"type":13,"tag":45,"props":170,"children":171},{"style":52},[172],{"type":18,"value":173},");\n",{"type":13,"tag":32,"props":175,"children":180},{"className":176,"code":177,"filename":178,"language":179,"meta":38,"style":38},"language-rs shiki shiki-themes github-light-default github-dark-default","pub fn get_pipeline_binary_data_khr(\n    device: crate :: vk :: vk::Device,\n    p_info: *const vk::PipelineBinaryDataInfoKHR,\n    p_pipeline_binary_key: *mut vk::PipelineBinaryKeyKHR,\n    p_pipeline_binary_data_size: *mut usize,\n    p_pipeline_binary_data: *mut c_void,\n) -> vk::Result;\n","Rust","rs",[181],{"type":13,"tag":41,"props":182,"children":183},{"__ignoreMap":38},[184,206,257,291,325,350,371],{"type":13,"tag":45,"props":185,"children":186},{"class":47,"line":48},[187,192,197,202],{"type":13,"tag":45,"props":188,"children":189},{"style":92},[190],{"type":18,"value":191},"pub",{"type":13,"tag":45,"props":193,"children":194},{"style":92},[195],{"type":18,"value":196}," fn",{"type":13,"tag":45,"props":198,"children":199},{"style":58},[200],{"type":18,"value":201}," get_pipeline_binary_data_khr",{"type":13,"tag":45,"props":203,"children":204},{"style":52},[205],{"type":18,"value":65},{"type":13,"tag":45,"props":207,"children":208},{"class":47,"line":68},[209,214,219,224,229,234,239,244,248,253],{"type":13,"tag":45,"props":210,"children":211},{"style":52},[212],{"type":18,"value":213},"    device",{"type":13,"tag":45,"props":215,"children":216},{"style":92},[217],{"type":18,"value":218},":",{"type":13,"tag":45,"props":220,"children":221},{"style":92},[222],{"type":18,"value":223}," crate",{"type":13,"tag":45,"props":225,"children":226},{"style":92},[227],{"type":18,"value":228}," ::",{"type":13,"tag":45,"props":230,"children":231},{"style":52},[232],{"type":18,"value":233}," vk ",{"type":13,"tag":45,"props":235,"children":236},{"style":92},[237],{"type":18,"value":238},"::",{"type":13,"tag":45,"props":240,"children":241},{"style":77},[242],{"type":18,"value":243}," vk",{"type":13,"tag":45,"props":245,"children":246},{"style":92},[247],{"type":18,"value":238},{"type":13,"tag":45,"props":249,"children":250},{"style":77},[251],{"type":18,"value":252},"Device",{"type":13,"tag":45,"props":254,"children":255},{"style":52},[256],{"type":18,"value":85},{"type":13,"tag":45,"props":258,"children":259},{"class":47,"line":88},[260,265,269,274,278,282,287],{"type":13,"tag":45,"props":261,"children":262},{"style":52},[263],{"type":18,"value":264},"    p_info",{"type":13,"tag":45,"props":266,"children":267},{"style":92},[268],{"type":18,"value":218},{"type":13,"tag":45,"props":270,"children":271},{"style":92},[272],{"type":18,"value":273}," *const",{"type":13,"tag":45,"props":275,"children":276},{"style":77},[277],{"type":18,"value":243},{"type":13,"tag":45,"props":279,"children":280},{"style":92},[281],{"type":18,"value":238},{"type":13,"tag":45,"props":283,"children":284},{"style":77},[285],{"type":18,"value":286},"PipelineBinaryDataInfoKHR",{"type":13,"tag":45,"props":288,"children":289},{"style":52},[290],{"type":18,"value":85},{"type":13,"tag":45,"props":292,"children":293},{"class":47,"line":117},[294,299,303,308,312,316,321],{"type":13,"tag":45,"props":295,"children":296},{"style":52},[297],{"type":18,"value":298},"    p_pipeline_binary_key",{"type":13,"tag":45,"props":300,"children":301},{"style":92},[302],{"type":18,"value":218},{"type":13,"tag":45,"props":304,"children":305},{"style":92},[306],{"type":18,"value":307}," *mut",{"type":13,"tag":45,"props":309,"children":310},{"style":77},[311],{"type":18,"value":243},{"type":13,"tag":45,"props":313,"children":314},{"style":92},[315],{"type":18,"value":238},{"type":13,"tag":45,"props":317,"children":318},{"style":77},[319],{"type":18,"value":320},"PipelineBinaryKeyKHR",{"type":13,"tag":45,"props":322,"children":323},{"style":52},[324],{"type":18,"value":85},{"type":13,"tag":45,"props":326,"children":327},{"class":47,"line":139},[328,333,337,341,346],{"type":13,"tag":45,"props":329,"children":330},{"style":52},[331],{"type":18,"value":332},"    p_pipeline_binary_data_size",{"type":13,"tag":45,"props":334,"children":335},{"style":92},[336],{"type":18,"value":218},{"type":13,"tag":45,"props":338,"children":339},{"style":92},[340],{"type":18,"value":307},{"type":13,"tag":45,"props":342,"children":343},{"style":77},[344],{"type":18,"value":345}," usize",{"type":13,"tag":45,"props":347,"children":348},{"style":52},[349],{"type":18,"value":85},{"type":13,"tag":45,"props":351,"children":352},{"class":47,"line":157},[353,358,362,366],{"type":13,"tag":45,"props":354,"children":355},{"style":52},[356],{"type":18,"value":357},"    p_pipeline_binary_data",{"type":13,"tag":45,"props":359,"children":360},{"style":92},[361],{"type":18,"value":218},{"type":13,"tag":45,"props":363,"children":364},{"style":92},[365],{"type":18,"value":307},{"type":13,"tag":45,"props":367,"children":368},{"style":52},[369],{"type":18,"value":370}," c_void,\n",{"type":13,"tag":45,"props":372,"children":374},{"class":47,"line":373},7,[375,380,385,389,393,398],{"type":13,"tag":45,"props":376,"children":377},{"style":52},[378],{"type":18,"value":379},") ",{"type":13,"tag":45,"props":381,"children":382},{"style":92},[383],{"type":18,"value":384},"->",{"type":13,"tag":45,"props":386,"children":387},{"style":77},[388],{"type":18,"value":243},{"type":13,"tag":45,"props":390,"children":391},{"style":92},[392],{"type":18,"value":238},{"type":13,"tag":45,"props":394,"children":395},{"style":77},[396],{"type":18,"value":397},"Result",{"type":13,"tag":45,"props":399,"children":400},{"style":52},[401],{"type":18,"value":402},";\n",{"type":13,"tag":404,"props":405,"children":406},"ul",{},[407,418,438,456,474],{"type":13,"tag":408,"props":409,"children":410},"li",{},[411,416],{"type":13,"tag":41,"props":412,"children":414},{"className":413},[],[415],{"type":18,"value":80},{"type":18,"value":417}," is the logical device that created the pipeline binary.",{"type":13,"tag":408,"props":419,"children":420},{},[421,427,429,436],{"type":13,"tag":41,"props":422,"children":424},{"className":423},[],[425],{"type":18,"value":426},"pInfo",{"type":18,"value":428}," is a pointer to a ",{"type":13,"tag":430,"props":431,"children":433},"a",{"href":432},"/man/VkPipelineBinaryDataInfoKHR",[434],{"type":18,"value":435},"VkPipelineBinaryDataInfoKHR",{"type":18,"value":437},"\nstructure which describes the pipeline binary to get data from.",{"type":13,"tag":408,"props":439,"children":440},{},[441,447,448,454],{"type":13,"tag":41,"props":442,"children":444},{"className":443},[],[445],{"type":18,"value":446},"pPipelineBinaryKey",{"type":18,"value":428},{"type":13,"tag":430,"props":449,"children":451},{"href":450},"/man/VkPipelineBinaryKeyKHR",[452],{"type":18,"value":453},"VkPipelineBinaryKeyKHR",{"type":18,"value":455},"\nstructure where the key for this binary will be written.",{"type":13,"tag":408,"props":457,"children":458},{},[459,465,466,472],{"type":13,"tag":41,"props":460,"children":462},{"className":461},[],[463],{"type":18,"value":464},"pPipelineBinaryDataSize",{"type":18,"value":428},{"type":13,"tag":41,"props":467,"children":469},{"className":468},[],[470],{"type":18,"value":471},"size_t",{"type":18,"value":473}," value\nrelated to the amount of data in the pipeline binary, as described\nbelow.",{"type":13,"tag":408,"props":475,"children":476},{},[477,483,485,491],{"type":13,"tag":41,"props":478,"children":480},{"className":479},[],[481],{"type":18,"value":482},"pPipelineBinaryData",{"type":18,"value":484}," is either ",{"type":13,"tag":41,"props":486,"children":488},{"className":487},[],[489],{"type":18,"value":490},"NULL",{"type":18,"value":492}," or a pointer to a buffer.",{"type":13,"tag":14,"props":494,"children":495},{},[496,498,503,505,510,512,517,519,524,526,530,532,537,539,544,546,551,553,558,560,566,568,574],{"type":18,"value":497},"If ",{"type":13,"tag":41,"props":499,"children":501},{"className":500},[],[502],{"type":18,"value":482},{"type":18,"value":504}," is ",{"type":13,"tag":41,"props":506,"children":508},{"className":507},[],[509],{"type":18,"value":490},{"type":18,"value":511},", then the size of the data, in bytes,\nthat is required to store the binary is returned in\n",{"type":13,"tag":41,"props":513,"children":515},{"className":514},[],[516],{"type":18,"value":464},{"type":18,"value":518},".\nOtherwise, ",{"type":13,"tag":41,"props":520,"children":522},{"className":521},[],[523],{"type":18,"value":464},{"type":18,"value":525}," ",{"type":13,"tag":21,"props":527,"children":529},{"type":528},"must",[],{"type":18,"value":531}," contain the size of the\nbuffer, in bytes, pointed to by ",{"type":13,"tag":41,"props":533,"children":535},{"className":534},[],[536],{"type":18,"value":482},{"type":18,"value":538},", and on return\n",{"type":13,"tag":41,"props":540,"children":542},{"className":541},[],[543],{"type":18,"value":464},{"type":18,"value":545}," is overwritten with the size of the data, in\nbytes, that is required to store the binary.\nIf ",{"type":13,"tag":41,"props":547,"children":549},{"className":548},[],[550],{"type":18,"value":464},{"type":18,"value":552}," is less than the size that is required to\nstore the binary, nothing is written to ",{"type":13,"tag":41,"props":554,"children":556},{"className":555},[],[557],{"type":18,"value":482},{"type":18,"value":559}," and\n",{"type":13,"tag":41,"props":561,"children":563},{"className":562},[],[564],{"type":18,"value":565},"VK_ERROR_NOT_ENOUGH_SPACE_KHR",{"type":18,"value":567}," will be returned, instead of\n",{"type":13,"tag":41,"props":569,"children":571},{"className":570},[],[572],{"type":18,"value":573},"VK_SUCCESS",{"type":18,"value":575},".",{"type":13,"tag":14,"props":577,"children":578},{},[579,580,586,588,594,596,600],{"type":18,"value":497},{"type":13,"tag":430,"props":581,"children":583},{"href":582},"/man/VkPhysicalDevicePipelineBinaryPropertiesKHR#limits-pipelineBinaryCompressedData",[584],{"type":18,"value":585},"pipelineBinaryCompressedData",{"type":18,"value":587}," is\n",{"type":13,"tag":41,"props":589,"children":591},{"className":590},[],[592],{"type":18,"value":593},"VK_FALSE",{"type":18,"value":595},", implementations ",{"type":13,"tag":21,"props":597,"children":599},{"type":598},"should",[],{"type":18,"value":601}," not return compressed pipeline\nbinary data to the application.",{"type":13,"tag":603,"props":604,"children":606},"validity-group",{"name":605},"Valid Usage (Implicit)",[607,634,658,681,705],{"type":13,"tag":608,"props":609,"children":611},"validity-field",{"name":610},"VUID-vkGetPipelineBinaryDataKHR-device-parameter",[612],{"type":13,"tag":14,"props":613,"children":614},{},[615,620,621,624,626,632],{"type":13,"tag":41,"props":616,"children":618},{"className":617},[],[619],{"type":18,"value":80},{"type":18,"value":525},{"type":13,"tag":21,"props":622,"children":623},{"type":528},[],{"type":18,"value":625}," be a valid ",{"type":13,"tag":430,"props":627,"children":629},{"href":628},"/man/VkDevice",[630],{"type":18,"value":631},"VkDevice",{"type":18,"value":633}," handle",{"type":13,"tag":608,"props":635,"children":637},{"name":636},"VUID-vkGetPipelineBinaryDataKHR-pInfo-parameter",[638],{"type":13,"tag":14,"props":639,"children":640},{},[641,646,647,650,652,656],{"type":13,"tag":41,"props":642,"children":644},{"className":643},[],[645],{"type":18,"value":426},{"type":18,"value":525},{"type":13,"tag":21,"props":648,"children":649},{"type":528},[],{"type":18,"value":651}," be a valid pointer to a valid ",{"type":13,"tag":430,"props":653,"children":654},{"href":432},[655],{"type":18,"value":435},{"type":18,"value":657}," structure",{"type":13,"tag":608,"props":659,"children":661},{"name":660},"VUID-vkGetPipelineBinaryDataKHR-pPipelineBinaryKey-parameter",[662],{"type":13,"tag":14,"props":663,"children":664},{},[665,670,671,674,676,680],{"type":13,"tag":41,"props":666,"children":668},{"className":667},[],[669],{"type":18,"value":446},{"type":18,"value":525},{"type":13,"tag":21,"props":672,"children":673},{"type":528},[],{"type":18,"value":675}," be a valid pointer to a ",{"type":13,"tag":430,"props":677,"children":678},{"href":450},[679],{"type":18,"value":453},{"type":18,"value":657},{"type":13,"tag":608,"props":682,"children":684},{"name":683},"VUID-vkGetPipelineBinaryDataKHR-pPipelineBinaryDataSize-parameter",[685],{"type":13,"tag":14,"props":686,"children":687},{},[688,693,694,697,698,703],{"type":13,"tag":41,"props":689,"children":691},{"className":690},[],[692],{"type":18,"value":464},{"type":18,"value":525},{"type":13,"tag":21,"props":695,"children":696},{"type":528},[],{"type":18,"value":675},{"type":13,"tag":41,"props":699,"children":701},{"className":700},[],[702],{"type":18,"value":471},{"type":18,"value":704}," value",{"type":13,"tag":608,"props":706,"children":708},{"name":707},"VUID-vkGetPipelineBinaryDataKHR-pPipelineBinaryData-parameter",[709],{"type":13,"tag":14,"props":710,"children":711},{},[712,714,719,721,727,729,734,735,740,742,747,748,751,753,758],{"type":18,"value":713},"If the value referenced by ",{"type":13,"tag":41,"props":715,"children":717},{"className":716},[],[718],{"type":18,"value":464},{"type":18,"value":720}," is not ",{"type":13,"tag":41,"props":722,"children":724},{"className":723},[],[725],{"type":18,"value":726},"0",{"type":18,"value":728},", and ",{"type":13,"tag":41,"props":730,"children":732},{"className":731},[],[733],{"type":18,"value":482},{"type":18,"value":720},{"type":13,"tag":41,"props":736,"children":738},{"className":737},[],[739],{"type":18,"value":490},{"type":18,"value":741},", ",{"type":13,"tag":41,"props":743,"children":745},{"className":744},[],[746],{"type":18,"value":482},{"type":18,"value":525},{"type":13,"tag":21,"props":749,"children":750},{"type":528},[],{"type":18,"value":752}," be a valid pointer to an array of ",{"type":13,"tag":41,"props":754,"children":756},{"className":755},[],[757],{"type":18,"value":464},{"type":18,"value":759}," bytes",{"type":13,"tag":761,"props":762,"children":763},"style",{},[764],{"type":18,"value":765},"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":38,"searchDepth":68,"depth":68,"links":767},[],"markdown",1725732620978]