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