[{"data":1,"prerenderedAt":705},["ShallowReactive",2],{"pcbQhIJ2sK":3},{"title":4,"description":5,"parent":6,"type":7,"xrefs":8,"body":9,"_type":704,"_id":4},"VkBufferImageCopy","Structure specifying a buffer image copy operation","VK_VERSION_1_0","structs",[],{"type":10,"children":11,"toc":702},"root",[12,46,380,505,668,696],{"type":13,"tag":14,"props":15,"children":16},"element","p",{},[17,20,27,29,35,37,44],{"type":18,"value":19},"text","For both ",{"type":13,"tag":21,"props":22,"children":24},"a",{"href":23},"/man/vkCmdCopyBufferToImage",[25],{"type":18,"value":26},"vkCmdCopyBufferToImage",{"type":18,"value":28}," and ",{"type":13,"tag":21,"props":30,"children":32},{"href":31},"/man/vkCmdCopyImageToBuffer",[33],{"type":18,"value":34},"vkCmdCopyImageToBuffer",{"type":18,"value":36},", each\nelement of ",{"type":13,"tag":38,"props":39,"children":41},"code",{"className":40},[],[42],{"type":18,"value":43},"pRegions",{"type":18,"value":45}," is a structure defined as:",{"type":13,"tag":47,"props":48,"children":49},"code-group",{},[50,157],{"type":13,"tag":51,"props":52,"children":58},"pre",{"className":53,"code":54,"filename":55,"language":56,"meta":57,"style":57},"language-c shiki shiki-themes github-light-default github-dark-default","typedef struct VkBufferImageCopy {\n    VkDeviceSize bufferOffset;\n    uint32_t bufferRowLength;\n    uint32_t bufferImageHeight;\n    VkImageSubresourceLayers imageSubresource;\n    VkOffset3D imageOffset;\n    VkExtent3D imageExtent;\n} VkBufferImageCopy;\n","C","c","",[59],{"type":13,"tag":38,"props":60,"children":61},{"__ignoreMap":57},[62,85,94,108,121,130,139,148],{"type":13,"tag":63,"props":64,"children":67},"span",{"class":65,"line":66},"line",1,[68,74,79],{"type":13,"tag":63,"props":69,"children":71},{"style":70},"--shiki-default:#CF222E;--shiki-dark:#FF7B72",[72],{"type":18,"value":73},"typedef",{"type":13,"tag":63,"props":75,"children":76},{"style":70},[77],{"type":18,"value":78}," struct",{"type":13,"tag":63,"props":80,"children":82},{"style":81},"--shiki-default:#1F2328;--shiki-dark:#E6EDF3",[83],{"type":18,"value":84}," VkBufferImageCopy {\n",{"type":13,"tag":63,"props":86,"children":88},{"class":65,"line":87},2,[89],{"type":13,"tag":63,"props":90,"children":91},{"style":81},[92],{"type":18,"value":93},"    VkDeviceSize bufferOffset;\n",{"type":13,"tag":63,"props":95,"children":97},{"class":65,"line":96},3,[98,103],{"type":13,"tag":63,"props":99,"children":100},{"style":70},[101],{"type":18,"value":102},"    uint32_t",{"type":13,"tag":63,"props":104,"children":105},{"style":81},[106],{"type":18,"value":107}," bufferRowLength;\n",{"type":13,"tag":63,"props":109,"children":111},{"class":65,"line":110},4,[112,116],{"type":13,"tag":63,"props":113,"children":114},{"style":70},[115],{"type":18,"value":102},{"type":13,"tag":63,"props":117,"children":118},{"style":81},[119],{"type":18,"value":120}," bufferImageHeight;\n",{"type":13,"tag":63,"props":122,"children":124},{"class":65,"line":123},5,[125],{"type":13,"tag":63,"props":126,"children":127},{"style":81},[128],{"type":18,"value":129},"    VkImageSubresourceLayers imageSubresource;\n",{"type":13,"tag":63,"props":131,"children":133},{"class":65,"line":132},6,[134],{"type":13,"tag":63,"props":135,"children":136},{"style":81},[137],{"type":18,"value":138},"    VkOffset3D imageOffset;\n",{"type":13,"tag":63,"props":140,"children":142},{"class":65,"line":141},7,[143],{"type":13,"tag":63,"props":144,"children":145},{"style":81},[146],{"type":18,"value":147},"    VkExtent3D imageExtent;\n",{"type":13,"tag":63,"props":149,"children":151},{"class":65,"line":150},8,[152],{"type":13,"tag":63,"props":153,"children":154},{"style":81},[155],{"type":18,"value":156},"} VkBufferImageCopy;\n",{"type":13,"tag":51,"props":158,"children":163},{"className":159,"code":160,"filename":161,"language":162,"meta":57,"style":57},"language-rs shiki shiki-themes github-light-default github-dark-default","pub struct BufferImageCopy {\n    buffer_offset: vk::DeviceSize, // Specified in bytes\n    buffer_row_length: u32, // Specified in texels\n    buffer_image_height: u32,\n    image_subresource: vk::ImageSubresourceLayers,\n    image_offset: vk::Offset3D, // Specified in pixels for both compressed and uncompressed images\n    image_extent: vk::Extent3D, // Specified in pixels for both compressed and uncompressed images\n}\n","Rust","rs",[164],{"type":13,"tag":38,"props":165,"children":166},{"__ignoreMap":57},[167,190,229,255,276,305,339,372],{"type":13,"tag":63,"props":168,"children":169},{"class":65,"line":66},[170,175,179,185],{"type":13,"tag":63,"props":171,"children":172},{"style":70},[173],{"type":18,"value":174},"pub",{"type":13,"tag":63,"props":176,"children":177},{"style":70},[178],{"type":18,"value":78},{"type":13,"tag":63,"props":180,"children":182},{"style":181},"--shiki-default:#953800;--shiki-dark:#FFA657",[183],{"type":18,"value":184}," BufferImageCopy",{"type":13,"tag":63,"props":186,"children":187},{"style":81},[188],{"type":18,"value":189}," {\n",{"type":13,"tag":63,"props":191,"children":192},{"class":65,"line":87},[193,198,203,208,213,218,223],{"type":13,"tag":63,"props":194,"children":195},{"style":81},[196],{"type":18,"value":197},"    buffer_offset",{"type":13,"tag":63,"props":199,"children":200},{"style":70},[201],{"type":18,"value":202},":",{"type":13,"tag":63,"props":204,"children":205},{"style":181},[206],{"type":18,"value":207}," vk",{"type":13,"tag":63,"props":209,"children":210},{"style":70},[211],{"type":18,"value":212},"::",{"type":13,"tag":63,"props":214,"children":215},{"style":181},[216],{"type":18,"value":217},"DeviceSize",{"type":13,"tag":63,"props":219,"children":220},{"style":81},[221],{"type":18,"value":222},", ",{"type":13,"tag":63,"props":224,"children":226},{"style":225},"--shiki-default:#6E7781;--shiki-dark:#8B949E",[227],{"type":18,"value":228},"// Specified in bytes\n",{"type":13,"tag":63,"props":230,"children":231},{"class":65,"line":96},[232,237,241,246,250],{"type":13,"tag":63,"props":233,"children":234},{"style":81},[235],{"type":18,"value":236},"    buffer_row_length",{"type":13,"tag":63,"props":238,"children":239},{"style":70},[240],{"type":18,"value":202},{"type":13,"tag":63,"props":242,"children":243},{"style":181},[244],{"type":18,"value":245}," u32",{"type":13,"tag":63,"props":247,"children":248},{"style":81},[249],{"type":18,"value":222},{"type":13,"tag":63,"props":251,"children":252},{"style":225},[253],{"type":18,"value":254},"// Specified in texels\n",{"type":13,"tag":63,"props":256,"children":257},{"class":65,"line":110},[258,263,267,271],{"type":13,"tag":63,"props":259,"children":260},{"style":81},[261],{"type":18,"value":262},"    buffer_image_height",{"type":13,"tag":63,"props":264,"children":265},{"style":70},[266],{"type":18,"value":202},{"type":13,"tag":63,"props":268,"children":269},{"style":181},[270],{"type":18,"value":245},{"type":13,"tag":63,"props":272,"children":273},{"style":81},[274],{"type":18,"value":275},",\n",{"type":13,"tag":63,"props":277,"children":278},{"class":65,"line":123},[279,284,288,292,296,301],{"type":13,"tag":63,"props":280,"children":281},{"style":81},[282],{"type":18,"value":283},"    image_subresource",{"type":13,"tag":63,"props":285,"children":286},{"style":70},[287],{"type":18,"value":202},{"type":13,"tag":63,"props":289,"children":290},{"style":181},[291],{"type":18,"value":207},{"type":13,"tag":63,"props":293,"children":294},{"style":70},[295],{"type":18,"value":212},{"type":13,"tag":63,"props":297,"children":298},{"style":181},[299],{"type":18,"value":300},"ImageSubresourceLayers",{"type":13,"tag":63,"props":302,"children":303},{"style":81},[304],{"type":18,"value":275},{"type":13,"tag":63,"props":306,"children":307},{"class":65,"line":132},[308,313,317,321,325,330,334],{"type":13,"tag":63,"props":309,"children":310},{"style":81},[311],{"type":18,"value":312},"    image_offset",{"type":13,"tag":63,"props":314,"children":315},{"style":70},[316],{"type":18,"value":202},{"type":13,"tag":63,"props":318,"children":319},{"style":181},[320],{"type":18,"value":207},{"type":13,"tag":63,"props":322,"children":323},{"style":70},[324],{"type":18,"value":212},{"type":13,"tag":63,"props":326,"children":327},{"style":181},[328],{"type":18,"value":329},"Offset3D",{"type":13,"tag":63,"props":331,"children":332},{"style":81},[333],{"type":18,"value":222},{"type":13,"tag":63,"props":335,"children":336},{"style":225},[337],{"type":18,"value":338},"// Specified in pixels for both compressed and uncompressed images\n",{"type":13,"tag":63,"props":340,"children":341},{"class":65,"line":141},[342,347,351,355,359,364,368],{"type":13,"tag":63,"props":343,"children":344},{"style":81},[345],{"type":18,"value":346},"    image_extent",{"type":13,"tag":63,"props":348,"children":349},{"style":70},[350],{"type":18,"value":202},{"type":13,"tag":63,"props":352,"children":353},{"style":181},[354],{"type":18,"value":207},{"type":13,"tag":63,"props":356,"children":357},{"style":70},[358],{"type":18,"value":212},{"type":13,"tag":63,"props":360,"children":361},{"style":181},[362],{"type":18,"value":363},"Extent3D",{"type":13,"tag":63,"props":365,"children":366},{"style":81},[367],{"type":18,"value":222},{"type":13,"tag":63,"props":369,"children":370},{"style":225},[371],{"type":18,"value":338},{"type":13,"tag":63,"props":373,"children":374},{"class":65,"line":150},[375],{"type":13,"tag":63,"props":376,"children":377},{"style":81},[378],{"type":18,"value":379},"}\n",{"type":13,"tag":381,"props":382,"children":383},"ul",{},[384,396,422,441,474],{"type":13,"tag":385,"props":386,"children":387},"li",{},[388,394],{"type":13,"tag":38,"props":389,"children":391},{"className":390},[],[392],{"type":18,"value":393},"bufferOffset",{"type":18,"value":395}," is the offset in bytes from the start of the buffer\nobject where the image data is copied from or to.",{"type":13,"tag":385,"props":397,"children":398},{},[399,405,406,412,414,420],{"type":13,"tag":38,"props":400,"children":402},{"className":401},[],[403],{"type":18,"value":404},"bufferRowLength",{"type":18,"value":28},{"type":13,"tag":38,"props":407,"children":409},{"className":408},[],[410],{"type":18,"value":411},"bufferImageHeight",{"type":18,"value":413}," specify in texels a\nsubregion of a larger two- or three-dimensional image in buffer memory,\nand control the addressing calculations.\nIf either of these values is zero, that aspect of the buffer memory is\nconsidered to be tightly packed according to the ",{"type":13,"tag":38,"props":415,"children":417},{"className":416},[],[418],{"type":18,"value":419},"imageExtent",{"type":18,"value":421},".",{"type":13,"tag":385,"props":423,"children":424},{},[425,431,433,439],{"type":13,"tag":38,"props":426,"children":428},{"className":427},[],[429],{"type":18,"value":430},"imageSubresource",{"type":18,"value":432}," is a ",{"type":13,"tag":21,"props":434,"children":436},{"href":435},"/man/VkImageSubresourceLayers",[437],{"type":18,"value":438},"VkImageSubresourceLayers",{"type":18,"value":440}," used to\nspecify the specific image subresources of the image used for the source\nor destination image data.",{"type":13,"tag":385,"props":442,"children":443},{},[444,450,452,458,459,465,466,472],{"type":13,"tag":38,"props":445,"children":447},{"className":446},[],[448],{"type":18,"value":449},"imageOffset",{"type":18,"value":451}," selects the initial ",{"type":13,"tag":38,"props":453,"children":455},{"className":454},[],[456],{"type":18,"value":457},"x",{"type":18,"value":222},{"type":13,"tag":38,"props":460,"children":462},{"className":461},[],[463],{"type":18,"value":464},"y",{"type":18,"value":222},{"type":13,"tag":38,"props":467,"children":469},{"className":468},[],[470],{"type":18,"value":471},"z",{"type":18,"value":473}," offsets\nin texels of the sub-region of the source or destination image data.",{"type":13,"tag":385,"props":475,"children":476},{},[477,482,484,490,491,497,498,504],{"type":13,"tag":38,"props":478,"children":480},{"className":479},[],[481],{"type":18,"value":419},{"type":18,"value":483}," is the size in texels of the image to copy in\n",{"type":13,"tag":38,"props":485,"children":487},{"className":486},[],[488],{"type":18,"value":489},"width",{"type":18,"value":222},{"type":13,"tag":38,"props":492,"children":494},{"className":493},[],[495],{"type":18,"value":496},"height",{"type":18,"value":28},{"type":13,"tag":38,"props":499,"children":501},{"className":500},[],[502],{"type":18,"value":503},"depth",{"type":18,"value":421},{"type":13,"tag":506,"props":507,"children":509},"validity-group",{"name":508},"Valid Usage",[510,552,586,613,632,650],{"type":13,"tag":511,"props":512,"children":514},"validity-field",{"name":513},"VUID-VkBufferImageCopy-bufferRowLength-09101",[515],{"type":13,"tag":14,"props":516,"children":517},{},[518,523,525,530,532,538,540,545,547],{"type":13,"tag":38,"props":519,"children":521},{"className":520},[],[522],{"type":18,"value":404},{"type":18,"value":524}," ",{"type":13,"tag":526,"props":527,"children":529},"normative",{"type":528},"must",[],{"type":18,"value":531}," be ",{"type":13,"tag":38,"props":533,"children":535},{"className":534},[],[536],{"type":18,"value":537},"0",{"type":18,"value":539},", or greater than or equal to the\n",{"type":13,"tag":38,"props":541,"children":543},{"className":542},[],[544],{"type":18,"value":489},{"type":18,"value":546}," member of ",{"type":13,"tag":38,"props":548,"children":550},{"className":549},[],[551],{"type":18,"value":419},{"type":13,"tag":511,"props":553,"children":555},{"name":554},"VUID-VkBufferImageCopy-bufferImageHeight-09102",[556],{"type":13,"tag":14,"props":557,"children":558},{},[559,564,565,568,569,574,575,580,581],{"type":13,"tag":38,"props":560,"children":562},{"className":561},[],[563],{"type":18,"value":411},{"type":18,"value":524},{"type":13,"tag":526,"props":566,"children":567},{"type":528},[],{"type":18,"value":531},{"type":13,"tag":38,"props":570,"children":572},{"className":571},[],[573],{"type":18,"value":537},{"type":18,"value":539},{"type":13,"tag":38,"props":576,"children":578},{"className":577},[],[579],{"type":18,"value":496},{"type":18,"value":546},{"type":13,"tag":38,"props":582,"children":584},{"className":583},[],[585],{"type":18,"value":419},{"type":13,"tag":511,"props":587,"children":589},{"name":588},"VUID-VkBufferImageCopy-aspectMask-09103",[590],{"type":13,"tag":14,"props":591,"children":592},{},[593,595,601,602,607,608,611],{"type":18,"value":594},"The ",{"type":13,"tag":38,"props":596,"children":598},{"className":597},[],[599],{"type":18,"value":600},"aspectMask",{"type":18,"value":546},{"type":13,"tag":38,"props":603,"children":605},{"className":604},[],[606],{"type":18,"value":430},{"type":18,"value":524},{"type":13,"tag":526,"props":609,"children":610},{"type":528},[],{"type":18,"value":612}," only have a\nsingle bit set",{"type":13,"tag":511,"props":614,"children":616},{"name":615},"VUID-VkBufferImageCopy-imageExtent-06659",[617],{"type":13,"tag":14,"props":618,"children":619},{},[620,626,627,630],{"type":13,"tag":38,"props":621,"children":623},{"className":622},[],[624],{"type":18,"value":625},"imageExtent.width",{"type":18,"value":524},{"type":13,"tag":526,"props":628,"children":629},{"type":528},[],{"type":18,"value":631}," not be 0",{"type":13,"tag":511,"props":633,"children":635},{"name":634},"VUID-VkBufferImageCopy-imageExtent-06660",[636],{"type":13,"tag":14,"props":637,"children":638},{},[639,645,646,649],{"type":13,"tag":38,"props":640,"children":642},{"className":641},[],[643],{"type":18,"value":644},"imageExtent.height",{"type":18,"value":524},{"type":13,"tag":526,"props":647,"children":648},{"type":528},[],{"type":18,"value":631},{"type":13,"tag":511,"props":651,"children":653},{"name":652},"VUID-VkBufferImageCopy-imageExtent-06661",[654],{"type":13,"tag":14,"props":655,"children":656},{},[657,663,664,667],{"type":13,"tag":38,"props":658,"children":660},{"className":659},[],[661],{"type":18,"value":662},"imageExtent.depth",{"type":18,"value":524},{"type":13,"tag":526,"props":665,"children":666},{"type":528},[],{"type":18,"value":631},{"type":13,"tag":506,"props":669,"children":671},{"name":670},"Valid Usage (Implicit)",[672],{"type":13,"tag":511,"props":673,"children":675},{"name":674},"VUID-VkBufferImageCopy-imageSubresource-parameter",[676],{"type":13,"tag":14,"props":677,"children":678},{},[679,684,685,688,690,694],{"type":13,"tag":38,"props":680,"children":682},{"className":681},[],[683],{"type":18,"value":430},{"type":18,"value":524},{"type":13,"tag":526,"props":686,"children":687},{"type":528},[],{"type":18,"value":689}," be a valid ",{"type":13,"tag":21,"props":691,"children":692},{"href":435},[693],{"type":18,"value":438},{"type":18,"value":695}," structure",{"type":13,"tag":697,"props":698,"children":699},"style",{},[700],{"type":18,"value":701},"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":57,"searchDepth":87,"depth":87,"links":703},[],"markdown",1729612435385]