Wraps a wait or signal semaphore action. More...

#include <foray_commandbuffer.hpp>

Public Member Functions
	operator VkSemaphoreSubmitInfo () const

Static Public Member Functions
static SemaphoreReference	Binary (VkSemaphore semaphore, VkPipelineStageFlags2 waitStage=VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT)
	Shorthand for initializing a SemaphoreReference struct for a binary semaphore.

static SemaphoreReference	Timeline (VkSemaphore semaphore, uint64_t value, VkPipelineStageFlags2 waitStage=VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT)
	Shorthand for initializing a SemaphoreReference struct for a timeline semaphore.

Public Attributes
VkSemaphoreType	SemaphoreType = VkSemaphoreType::VK_SEMAPHORE_TYPE_BINARY
	Type of semaphore.

uint64_t	TimelineValue = 0
	Timeline value to signal/wait (ignored if binary semaphore)

VkSemaphore	Semaphore = nullptr
	Semaphore.

VkPipelineStageFlags2	WaitStage = VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT
	Stage masks.

Detailed Description

Wraps a wait or signal semaphore action.

Member Function Documentation

◆ Binary()

static SemaphoreReference foray::core::SemaphoreReference::Binary	(	VkSemaphore	semaphore,
		VkPipelineStageFlags2	waitStage = `VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT`
	)

static

Shorthand for initializing a SemaphoreReference struct for a binary semaphore.

Parameters

semaphore	Semaphore
waitStage	Wait / Signal stage masks

◆ operator VkSemaphoreSubmitInfo()

foray::core::SemaphoreReference::operator VkSemaphoreSubmitInfo ( ) const

◆ Timeline()

static SemaphoreReference foray::core::SemaphoreReference::Timeline	(	VkSemaphore	semaphore,
		uint64_t	value,
		VkPipelineStageFlags2	waitStage = `VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT`
	)

static

Shorthand for initializing a SemaphoreReference struct for a timeline semaphore.

Parameters

semaphore	Semaphore
value	Timeline value to wait for / signal
waitStage	Wait / Signal stage masks

Member Data Documentation

◆ Semaphore

VkSemaphore foray::core::SemaphoreReference::Semaphore = nullptr

Semaphore.

◆ SemaphoreType

VkSemaphoreType foray::core::SemaphoreReference::SemaphoreType = VkSemaphoreType::VK_SEMAPHORE_TYPE_BINARY

Type of semaphore.

◆ TimelineValue

uint64_t foray::core::SemaphoreReference::TimelineValue = 0

Timeline value to signal/wait (ignored if binary semaphore)

◆ WaitStage

VkPipelineStageFlags2 foray::core::SemaphoreReference::WaitStage = VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT

Stage masks.

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

src/core/foray_commandbuffer.hpp

Public Member Functions

Static Public Member Functions

Public Attributes