[{"data":1,"prerenderedAt":644},["ShallowReactive",2],{"$fHrvIkPif_wFwue_OZ13wHIGS2DtzZJ0VrHEFQ0-bkIQ":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":643,"_id":4},"vkRegisterCustomBorderColorEXT","Register a custom border color","VK_EXT_descriptor_heap","protos",[],{"type":10,"children":11,"toc":641},"root",[12,20,330,394,436,469,488,513,555,635],{"type":13,"tag":14,"props":15,"children":16},"element","p",{},[17],{"type":18,"value":19},"text","To register a custom border color, call:",{"type":13,"tag":21,"props":22,"children":23},"code-group",{},[24,145],{"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 vkRegisterCustomBorderColorEXT(\n    VkDevice                                            device,\n    const VkSamplerCustomBorderColorCreateInfoEXT*      pBorderColor,\n    VkBool32                                            requestIndex,\n    uint32_t*                                           pIndex);\n","C","c","",[33],{"type":13,"tag":34,"props":35,"children":36},"code",{"__ignoreMap":31},[37,59,79,108,126],{"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,89,94,99,104],{"type":13,"tag":38,"props":84,"children":86},{"style":85},"--shiki-default:#CF222E;--shiki-dark:#FF7B72",[87],{"type":18,"value":88},"    const",{"type":13,"tag":38,"props":90,"children":91},{"style":45},[92],{"type":18,"value":93}," VkSamplerCustomBorderColorCreateInfoEXT",{"type":13,"tag":38,"props":95,"children":96},{"style":85},[97],{"type":18,"value":98},"*",{"type":13,"tag":38,"props":100,"children":101},{"style":70},[102],{"type":18,"value":103},"      pBorderColor",{"type":13,"tag":38,"props":105,"children":106},{"style":45},[107],{"type":18,"value":78},{"type":13,"tag":38,"props":109,"children":111},{"class":40,"line":110},4,[112,117,122],{"type":13,"tag":38,"props":113,"children":114},{"style":45},[115],{"type":18,"value":116},"    VkBool32                                            ",{"type":13,"tag":38,"props":118,"children":119},{"style":70},[120],{"type":18,"value":121},"requestIndex",{"type":13,"tag":38,"props":123,"children":124},{"style":45},[125],{"type":18,"value":78},{"type":13,"tag":38,"props":127,"children":129},{"class":40,"line":128},5,[130,135,140],{"type":13,"tag":38,"props":131,"children":132},{"style":85},[133],{"type":18,"value":134},"    uint32_t*",{"type":13,"tag":38,"props":136,"children":137},{"style":70},[138],{"type":18,"value":139},"                                           pIndex",{"type":13,"tag":38,"props":141,"children":142},{"style":45},[143],{"type":18,"value":144},");\n",{"type":13,"tag":25,"props":146,"children":151},{"className":147,"code":148,"filename":149,"language":150,"meta":31,"style":31},"language-rs shiki shiki-themes github-light-default github-dark-default","pub fn register_custom_border_color_ext(\n    device: vk::Device,\n    p_border_color: *const vk::SamplerCustomBorderColorCreateInfoEXT,\n    request_index: vk::Bool32,\n    p_index: *mut u32,\n) -> vk::Result;\n","Rust","rs",[152],{"type":13,"tag":34,"props":153,"children":154},{"__ignoreMap":31},[155,177,209,243,272,298],{"type":13,"tag":38,"props":156,"children":157},{"class":40,"line":41},[158,163,168,173],{"type":13,"tag":38,"props":159,"children":160},{"style":85},[161],{"type":18,"value":162},"pub",{"type":13,"tag":38,"props":164,"children":165},{"style":85},[166],{"type":18,"value":167}," fn",{"type":13,"tag":38,"props":169,"children":170},{"style":51},[171],{"type":18,"value":172}," register_custom_border_color_ext",{"type":13,"tag":38,"props":174,"children":175},{"style":45},[176],{"type":18,"value":58},{"type":13,"tag":38,"props":178,"children":179},{"class":40,"line":61},[180,185,190,195,200,205],{"type":13,"tag":38,"props":181,"children":182},{"style":45},[183],{"type":18,"value":184},"    device",{"type":13,"tag":38,"props":186,"children":187},{"style":85},[188],{"type":18,"value":189},":",{"type":13,"tag":38,"props":191,"children":192},{"style":70},[193],{"type":18,"value":194}," vk",{"type":13,"tag":38,"props":196,"children":197},{"style":85},[198],{"type":18,"value":199},"::",{"type":13,"tag":38,"props":201,"children":202},{"style":70},[203],{"type":18,"value":204},"Device",{"type":13,"tag":38,"props":206,"children":207},{"style":45},[208],{"type":18,"value":78},{"type":13,"tag":38,"props":210,"children":211},{"class":40,"line":81},[212,217,221,226,230,234,239],{"type":13,"tag":38,"props":213,"children":214},{"style":45},[215],{"type":18,"value":216},"    p_border_color",{"type":13,"tag":38,"props":218,"children":219},{"style":85},[220],{"type":18,"value":189},{"type":13,"tag":38,"props":222,"children":223},{"style":85},[224],{"type":18,"value":225}," *const",{"type":13,"tag":38,"props":227,"children":228},{"style":70},[229],{"type":18,"value":194},{"type":13,"tag":38,"props":231,"children":232},{"style":85},[233],{"type":18,"value":199},{"type":13,"tag":38,"props":235,"children":236},{"style":70},[237],{"type":18,"value":238},"SamplerCustomBorderColorCreateInfoEXT",{"type":13,"tag":38,"props":240,"children":241},{"style":45},[242],{"type":18,"value":78},{"type":13,"tag":38,"props":244,"children":245},{"class":40,"line":110},[246,251,255,259,263,268],{"type":13,"tag":38,"props":247,"children":248},{"style":45},[249],{"type":18,"value":250},"    request_index",{"type":13,"tag":38,"props":252,"children":253},{"style":85},[254],{"type":18,"value":189},{"type":13,"tag":38,"props":256,"children":257},{"style":70},[258],{"type":18,"value":194},{"type":13,"tag":38,"props":260,"children":261},{"style":85},[262],{"type":18,"value":199},{"type":13,"tag":38,"props":264,"children":265},{"style":70},[266],{"type":18,"value":267},"Bool32",{"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":128},[275,280,284,289,294],{"type":13,"tag":38,"props":276,"children":277},{"style":45},[278],{"type":18,"value":279},"    p_index",{"type":13,"tag":38,"props":281,"children":282},{"style":85},[283],{"type":18,"value":189},{"type":13,"tag":38,"props":285,"children":286},{"style":85},[287],{"type":18,"value":288}," *mut",{"type":13,"tag":38,"props":290,"children":291},{"style":70},[292],{"type":18,"value":293}," u32",{"type":13,"tag":38,"props":295,"children":296},{"style":45},[297],{"type":18,"value":78},{"type":13,"tag":38,"props":299,"children":301},{"class":40,"line":300},6,[302,307,312,316,320,325],{"type":13,"tag":38,"props":303,"children":304},{"style":45},[305],{"type":18,"value":306},") ",{"type":13,"tag":38,"props":308,"children":309},{"style":85},[310],{"type":18,"value":311},"->",{"type":13,"tag":38,"props":313,"children":314},{"style":70},[315],{"type":18,"value":194},{"type":13,"tag":38,"props":317,"children":318},{"style":85},[319],{"type":18,"value":199},{"type":13,"tag":38,"props":321,"children":322},{"style":70},[323],{"type":18,"value":324},"Result",{"type":13,"tag":38,"props":326,"children":327},{"style":45},[328],{"type":18,"value":329},";\n",{"type":13,"tag":331,"props":332,"children":333},"ul",{},[334,345,365,375],{"type":13,"tag":335,"props":336,"children":337},"li",{},[338,343],{"type":13,"tag":34,"props":339,"children":341},{"className":340},[],[342],{"type":18,"value":73},{"type":18,"value":344}," is the logical device where the border color is registered.",{"type":13,"tag":335,"props":346,"children":347},{},[348,354,356,363],{"type":13,"tag":34,"props":349,"children":351},{"className":350},[],[352],{"type":18,"value":353},"pBorderColor",{"type":18,"value":355}," is a pointer to a\n",{"type":13,"tag":357,"props":358,"children":360},"a",{"href":359},"/man/VkSamplerCustomBorderColorCreateInfoEXT",[361],{"type":18,"value":362},"VkSamplerCustomBorderColorCreateInfoEXT",{"type":18,"value":364}," structure specifying the\ncustom border color value to register.",{"type":13,"tag":335,"props":366,"children":367},{},[368,373],{"type":13,"tag":34,"props":369,"children":371},{"className":370},[],[372],{"type":18,"value":121},{"type":18,"value":374}," is a Boolean value indicating if a specific index is\nrequested or not.",{"type":13,"tag":335,"props":376,"children":377},{},[378,384,386,392],{"type":13,"tag":34,"props":379,"children":381},{"className":380},[],[382],{"type":18,"value":383},"pIndex",{"type":18,"value":385}," is a pointer to a ",{"type":13,"tag":34,"props":387,"children":389},{"className":388},[],[390],{"type":18,"value":391},"uint32_t",{"type":18,"value":393}," index value that will be\nwritten by the command upon success.",{"type":13,"tag":14,"props":395,"children":396},{},[397,399,404,406,412,414,419,421,427,429,434],{"type":18,"value":398},"If ",{"type":13,"tag":34,"props":400,"children":402},{"className":401},[],[403],{"type":18,"value":121},{"type":18,"value":405}," is ",{"type":13,"tag":34,"props":407,"children":409},{"className":408},[],[410],{"type":18,"value":411},"VK_TRUE",{"type":18,"value":413},", the value present in ",{"type":13,"tag":34,"props":415,"children":417},{"className":416},[],[418],{"type":18,"value":383},{"type":18,"value":420},"\nwhen passed to the command is a requested index, and rather than returning a\nnew index, the implementation will attempt to register that index, leaving\nthe value intact.\nIf the implementation is unable to register a requested index,\n",{"type":13,"tag":34,"props":422,"children":424},{"className":423},[],[425],{"type":18,"value":426},"VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS",{"type":18,"value":428}," will be returned.\nIf an index has not been registered (either explicitly or implicitly by\ncreating a sampler object), or if it has been subsequently unregistered, the\nimplementation ",{"type":13,"tag":430,"props":431,"children":433},"normative",{"type":432},"must",[],{"type":18,"value":435}," register that index successfully.",{"type":13,"tag":14,"props":437,"children":438},{},[439,440,445,446,452,454,459,461,467],{"type":18,"value":398},{"type":13,"tag":34,"props":441,"children":443},{"className":442},[],[444],{"type":18,"value":121},{"type":18,"value":405},{"type":13,"tag":34,"props":447,"children":449},{"className":448},[],[450],{"type":18,"value":451},"VK_FALSE",{"type":18,"value":453},", the value stored in ",{"type":13,"tag":34,"props":455,"children":457},{"className":456},[],[458],{"type":18,"value":383},{"type":18,"value":460}," is\nignored, and a new index will be returned if the implementation is able to\nregister a new index.\nIf the implementation is unable to register a new index,\n",{"type":13,"tag":34,"props":462,"children":464},{"className":463},[],[465],{"type":18,"value":466},"VK_ERROR_TOO_MANY_OBJECTS",{"type":18,"value":468}," will be returned.",{"type":13,"tag":14,"props":470,"children":471},{},[472,474,478,480,486],{"type":18,"value":473},"If an index is successfully registered, it ",{"type":13,"tag":430,"props":475,"children":477},{"type":476},"can",[],{"type":18,"value":479}," be used when writing a\nsampler descriptor or creating a sampler object to use with the custom\nborder color, via ",{"type":13,"tag":357,"props":481,"children":483},{"href":482},"/man/VkSamplerCustomBorderColorIndexCreateInfoEXT",[484],{"type":18,"value":485},"VkSamplerCustomBorderColorIndexCreateInfoEXT",{"type":18,"value":487},".",{"type":13,"tag":489,"props":490,"children":491},"note",{},[492],{"type":13,"tag":14,"props":493,"children":494},{},[495,497,503,505,511],{"type":18,"value":496},"The type of border color is not specified by this command\n(",{"type":13,"tag":34,"props":498,"children":500},{"className":499},[],[501],{"type":18,"value":502},"VK_BORDER_COLOR_FLOAT_CUSTOM_EXT",{"type":18,"value":504}," vs.\n",{"type":13,"tag":34,"props":506,"children":508},{"className":507},[],[509],{"type":18,"value":510},"VK_BORDER_COLOR_INT_CUSTOM_EXT",{"type":18,"value":512},"); the data will be interpreted at the\npoint the border color is sampled with an actual sampler.\nImplementations are expected to store the data as raw bytes if they do not\nneed the format to be specified.",{"type":13,"tag":514,"props":515,"children":517},"validity-group",{"name":516},"Valid Usage",[518],{"type":13,"tag":519,"props":520,"children":522},"validity-field",{"name":521},"VUID-vkRegisterCustomBorderColorEXT-requestIndex-11287",[523],{"type":13,"tag":14,"props":524,"children":525},{},[526,527,532,533,538,539,544,547,549],{"type":18,"value":398},{"type":13,"tag":34,"props":528,"children":530},{"className":529},[],[531],{"type":18,"value":121},{"type":18,"value":405},{"type":13,"tag":34,"props":534,"children":536},{"className":535},[],[537],{"type":18,"value":411},{"type":18,"value":453},{"type":13,"tag":34,"props":540,"children":542},{"className":541},[],[543],{"type":18,"value":383},{"type":13,"tag":430,"props":545,"children":546},{"type":432},[],{"type":18,"value":548}," be less than ",{"type":13,"tag":357,"props":550,"children":552},{"href":551},"/man/VkPhysicalDeviceCustomBorderColorPropertiesEXT#limits-maxCustomBorderColorSamplers",[553],{"type":18,"value":554},"maxCustomBorderColorSamplers",{"type":13,"tag":514,"props":556,"children":558},{"name":557},"Valid Usage (Implicit)",[559,586,610],{"type":13,"tag":519,"props":560,"children":562},{"name":561},"VUID-vkRegisterCustomBorderColorEXT-device-parameter",[563],{"type":13,"tag":14,"props":564,"children":565},{},[566,571,573,576,578,584],{"type":13,"tag":34,"props":567,"children":569},{"className":568},[],[570],{"type":18,"value":73},{"type":18,"value":572}," ",{"type":13,"tag":430,"props":574,"children":575},{"type":432},[],{"type":18,"value":577}," be a valid ",{"type":13,"tag":357,"props":579,"children":581},{"href":580},"/man/VkDevice",[582],{"type":18,"value":583},"VkDevice",{"type":18,"value":585}," handle",{"type":13,"tag":519,"props":587,"children":589},{"name":588},"VUID-vkRegisterCustomBorderColorEXT-pBorderColor-parameter",[590],{"type":13,"tag":14,"props":591,"children":592},{},[593,598,599,602,604,608],{"type":13,"tag":34,"props":594,"children":596},{"className":595},[],[597],{"type":18,"value":353},{"type":18,"value":572},{"type":13,"tag":430,"props":600,"children":601},{"type":432},[],{"type":18,"value":603}," be a valid pointer to a valid ",{"type":13,"tag":357,"props":605,"children":606},{"href":359},[607],{"type":18,"value":362},{"type":18,"value":609}," structure",{"type":13,"tag":519,"props":611,"children":613},{"name":612},"VUID-vkRegisterCustomBorderColorEXT-pIndex-parameter",[614],{"type":13,"tag":14,"props":615,"children":616},{},[617,622,623,626,628,633],{"type":13,"tag":34,"props":618,"children":620},{"className":619},[],[621],{"type":18,"value":383},{"type":18,"value":572},{"type":13,"tag":430,"props":624,"children":625},{"type":432},[],{"type":18,"value":627}," be a valid pointer to a ",{"type":13,"tag":34,"props":629,"children":631},{"className":630},[],[632],{"type":18,"value":391},{"type":18,"value":634}," value",{"type":13,"tag":636,"props":637,"children":638},"style",{},[639],{"type":18,"value":640},"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":642},[],"markdown",1773121651448]