Method AcquireNextImage

vgpu/surface.go:352–395

AcquireNextImage gets the next frame index to render to. It automatically handles any issues with out-of-date swapchain. It triggers the ImageAcquired semaphore when image actually acquired. Must call SubmitRender with command to launch command contingent on that semaphore. It returns false if the s

()

// Must call SubmitRender with command to launch command contingent
// on that semaphore. It returns false if the swapchain size is zero.
func (sf *Surface) AcquireNextImage() (uint32, bool) {
	dev := sf.Device.Device
	for {
		vk.WaitForFences(dev, 1, []vk.Fence{sf.RenderFence}, vk.True, vk.MaxUint64)
		vk.ResetFences(dev, 1, []vk.Fence{sf.RenderFence})
		var idx uint32
		if sf.NeedsConfig {
			// we must skip FreeSwapchain for NeedsConfig
			if !sf.ConfigSwapchain() {
				if Debug {
					fmt.Println("vgpu.Surface.AcquireNextImage: bailing on ConfigSwapchain caused by NeedsConfig (somewhat unexpected)")
				}
				return idx, false
			}
			sf.Render.SetSize(sf.Format.Size)
			sf.ReConfigFrames()
			sf.NeedsConfig = false
			if Debug {
				fmt.Println("vgpu.Surface.AcquireNextImage: did NeedsConfig update")
			}
			continue
		}
		ret := vk.AcquireNextImage(dev, sf.Swapchain, vk.MaxUint64, sf.ImageAcquired, vk.NullFence, &idx)
		switch ret {
		case vk.ErrorOutOfDate, vk.Suboptimal:
			if !sf.ReConfigSwapchain() {
				if Debug {
					fmt.Println("vgpu.Surface.AcquireNextImage: bailing on zero swapchain size")
				}
				sf.NeedsConfig = true
				return idx, false
			}
			if Debug {
				fmt.Printf("vgpu.Surface.AcquireNextImage: new format: %#v\n", sf.Format)
			}
			continue // try again
		case vk.Success:
			return idx, true
		default:
			IfPanic(NewError(ret))
			return idx, true
		}
	}
}

// SubmitRender submits a rendering command that must have been added
// to the given command buffer, calling CmdEnd on the buffer first.