Method texture_get_data_async

servers/rendering/rendering_device.cpp:2143–2271

}

Error RenderingDevice::texture_get_data_async(RID p_texture, uint32_t p_layer, const Callable &p_callback) {
	ERR_RENDER_THREAD_GUARD_V(ERR_UNAVAILABLE);

	Texture *tex = texture_owner.get_or_null(p_texture);
	ERR_FAIL_NULL_V(tex, ERR_INVALID_PARAMETER);

	ERR_FAIL_COND_V_MSG(tex->bound, ERR_INVALID_PARAMETER, "Texture can't be retrieved while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to `RenderingDevice.FINAL_ACTION_CONTINUE`) to retrieve this texture.");
	ERR_FAIL_COND_V_MSG(!(tex->usage_flags & TEXTURE_USAGE_CAN_COPY_FROM_BIT), ERR_INVALID_PARAMETER, "Texture requires the `RenderingDevice.TEXTURE_USAGE_CAN_COPY_FROM_BIT` to be set to be retrieved.");
	ERR_FAIL_COND_V(p_layer >= tex->layers, ERR_INVALID_PARAMETER);

	// Clear the texture if the driver requires it during its first use.
	_texture_check_pending_clear(p_texture, tex);

	_check_transfer_worker_texture(tex);

	thread_local LocalVector<RDD::TextureCopyableLayout> mip_layouts;
	mip_layouts.resize(tex->mipmaps);
	for (uint32_t i = 0; i < tex->mipmaps; i++) {
		RDD::TextureSubresource subres;
		subres.aspect = RDD::TEXTURE_ASPECT_COLOR;
		subres.layer = p_layer;
		subres.mipmap = i;
		driver->texture_get_copyable_layout(tex->driver_id, subres, &mip_layouts[i]);

		// Assuming layers are tightly packed. If this is not true on some driver, we must modify the copy algorithm.
		DEV_ASSERT(mip_layouts[i].layer_pitch == mip_layouts[i].size / tex->layers);
	}

	ERR_FAIL_COND_V(mip_layouts.is_empty(), ERR_INVALID_PARAMETER);

	if (_texture_make_mutable(tex, p_texture)) {
		// The texture must be mutable to be used as a copy source due to layout transitions.
		draw_graph.add_synchronization();
	}

	TextureGetDataRequest get_data_request;
	get_data_request.callback = p_callback;
	get_data_request.frame_local_index = frames[frame].download_buffer_texture_copy_regions.size();
	get_data_request.width = tex->width;
	get_data_request.height = tex->height;
	get_data_request.depth = tex->depth;
	get_data_request.format = tex->format;
	get_data_request.mipmaps = tex->mipmaps;

	uint32_t block_w, block_h;
	get_compressed_image_format_block_dimensions(tex->format, block_w, block_h);

	uint32_t pixel_size = get_image_format_pixel_size(tex->format);
	uint32_t pixel_rshift = get_compressed_image_format_pixel_rshift(tex->format);

	uint32_t w, h, d;
	uint32_t required_align = driver->api_trait_get(RDD::API_TRAIT_TEXTURE_TRANSFER_ALIGNMENT);
	uint32_t pitch_step = driver->api_trait_get(RDD::API_TRAIT_TEXTURE_DATA_ROW_PITCH_STEP);
	uint32_t region_size = texture_download_region_size_px;
	uint32_t logic_w = tex->width;
	uint32_t logic_h = tex->height;
	uint32_t mipmap_offset = 0;
	uint32_t block_write_offset;