Method ImageCopy

xyz/render.go:154–168

ImageCopy returns a copy of the current rendered image from the Frame RenderFrame. A re-used image.RGBA is returned. This same image is used across calls to avoid large memory allocations, so it will automatically update after the next ImageCopy call. The underlying image is in the [ImgCopy] field.

()

// The underlying image is in the [ImgCopy] field.
// If a persistent image is required, call [imagex.CloneAsRGBA].
func (sc *Scene) ImageCopy() (*image.RGBA, error) {
	fr := sc.Frame
	if fr == nil {
		return nil, fmt.Errorf("xyz.Scene ImageCopy: Scene does not have a Frame")
	}
	sy := &sc.Phong.Sys
	tcmd := sy.MemCmdStart()
	fr.GrabImage(tcmd, 0) // note: re-uses a persistent Grab image
	sy.MemCmdEndSubmitWaitFree()
	err := fr.Render.Grab.DevGoImageCopy(&sc.imgCopy)
	if err == nil {
		return &sc.imgCopy, err
	}
	return nil, err
}

// ImageUpdate configures, updates, and renders the scene, then returns [Scene.Image].
func (sc *Scene) ImageUpdate() (*image.RGBA, error) {