How to properly cancel an image to image generation.

[StudenteChamp2]

Found this with Google Agent. Is it safe?

`

	sd_set_progress_callback(ProgressCallback, &m_stopRender);
	sd_image_t* result = nullptr;
	try
	{
		result = generate_image(ctx, &sd_img_gen_params);
		_ASSERT(result && result[0].data);
	}
	catch (const std::runtime_error& e)
	{
		goto FreeMemory;
	}

`

Progress CB look like this:
void ProgressCallback(int step, int steps, float time, void* user_data) { if (*((bool*)user_data)) { throw std::runtime_error("Generation interrupted."); } }

FreeMemory free the context(sd_ctx_t* )and output image memory.

THANKS!

[Danmoreng]

Not yet implemented. See #1124
If you need it, you need to patch it yourself. Codex wrote me this patch for my GUI, works fine: https://github.com/Danmoreng/diffusion-desk/blob/main/scripts/patches/stable-diffusion-cancel.patch

[StudenteChamp2]

We will apply it thanks!

[leejet]

This is supported now.

[StudenteChamp2]

Great news thank you!

[Trylz]

Please is there an example of how to use it?

[wbruna]

Please is there an example of how to use it?

Just call:

sd_cancel_generation(context, mode);

passing the image generation context and the mode (SD_CANCEL_ALL for interrupting everything, or SD_CANCEL_NEW_LATENTS to avoid throwing away images that were already generated, but not yet VAE-decoded). It will make sd_generate_image finish early, returning the already generated images, if any. sd_cancel_generation can be called from a different thread, a signal handler, or any API callback (preview, log, etc).