cs237::Window::SyncObjs Struct Reference

a container for a frame's synchronization objects More...

#include <cs237-window.hpp>

Collaboration diagram for cs237::Window::SyncObjs:

Public Member Functions
	SyncObjs (Window *w)
	create a SyncObjs container
	SyncObjs ()=delete
	SyncObjs (SyncObjs &)=delete
	SyncObjs (SyncObjs const &)=delete
	SyncObjs (SyncObjs &&)=delete
	~SyncObjs ()
	destroy the objects
void	allocate ()
	helper method for allocating the synchronization objects in the constructor
vk::ResultValue< uint32_t >	acquireNextImage ()
	acquire the next image from the window's swap chain.
void	reset ()
	reset the in-flight fence of this frame
void	submitCommands (vk::Queue q, vk::CommandBuffer const &cmdBuf)
vk::Result	present (vk::Queue q, uint32_t imageIndex)
	present the frame

Public Attributes
Window *	win
	the owning window
vk::Semaphore	imageAvailable
vk::Semaphore	renderFinished
vk::Fence	inFlight

Detailed Description

a container for a frame's synchronization objects

Constructor & Destructor Documentation

SyncObjs() [1/5]

cs237::Window::SyncObjs::SyncObjs ( Window *  w )

inlineexplicit

create a SyncObjs container

SyncObjs() [2/5]

cs237::Window::SyncObjs::SyncObjs ( )

delete

SyncObjs() [3/5]

cs237::Window::SyncObjs::SyncObjs ( SyncObjs &  )

delete

SyncObjs() [4/5]

cs237::Window::SyncObjs::SyncObjs ( SyncObjs const &  )

delete

SyncObjs() [5/5]

cs237::Window::SyncObjs::SyncObjs ( SyncObjs &&  )

delete

~SyncObjs()

cs237::Window::SyncObjs::~SyncObjs

(

)

destroy the objects

Member Function Documentation

acquireNextImage()

vk::ResultValue< uint32_t > cs237::Window::SyncObjs::acquireNextImage

(

)

acquire the next image from the window's swap chain.

Returns

the next image's index

allocate()

void cs237::Window::SyncObjs::allocate

(

)

helper method for allocating the synchronization objects in the constructor

present()

vk::Result cs237::Window::SyncObjs::present	(	vk::Queue	q,
		uint32_t	imageIndex
	)

present the frame

Parameters

q	the presentation queue
imageIndex	the image index to present

Returns

the return status of presenting the image

reset()

void cs237::Window::SyncObjs::reset

(

)

reset the in-flight fence of this frame

submitCommands()

void cs237::Window::SyncObjs::submitCommands	(	vk::Queue	q,
		vk::CommandBuffer const &	cmdBuf
	)

submit a command buffer to a queue using this frame's synchronization objects

Parameters

q	the queue to submit the commands to
cmdBuf	the command buffer to submit

Member Data Documentation

imageAvailable

vk::Semaphore cs237::Window::SyncObjs::imageAvailable

semaphore for signaling when the image object is available

inFlight

vk::Fence cs237::Window::SyncObjs::inFlight

fence for synchronizing on the termination of the rendering operation

renderFinished

vk::Semaphore cs237::Window::SyncObjs::renderFinished

semaphore for signaling when render pass is finished

win

Window* cs237::Window::SyncObjs::win

the owning window

---

The documentation for this struct was generated from the following file:

• /Users/jhr/Classes/23700/f2023/solutions/cs237-library/include/cs237-window.hpp