This class maintains different copies of a page of data between stages of the graphics pipeline (or any other pipelining context). More...

#include "pipelineCycler.h"

Inheritance diagram for PipelineCycler< CycleDataType >:

Public Member Functions
	PipelineCycler (Pipeline *pipeline=nullptr)

	PipelineCycler (CycleDataType &&initial_data, Pipeline *pipeline=nullptr)

	PipelineCycler (const PipelineCycler< CycleDataType > &copy)

CycleDataType *	cheat () const
	Returns a pointer without counting it. More...

CycleDataType *	elevate_read (const CycleDataType pointer, Thread current_thread)
	See PipelineCyclerBase::elevate_read(). More...

CycleDataType *	elevate_read_stage (int pipeline_stage, const CycleDataType pointer, Thread current_thread)
	See PipelineCyclerBase::elevate_read_stage(). More...

CycleDataType *	elevate_read_stage_upstream (int pipeline_stage, const CycleDataType pointer, bool force_to_0, Thread current_thread)
	See PipelineCyclerBase::elevate_read_stage_upstream(). More...

CycleDataType *	elevate_read_upstream (const CycleDataType pointer, bool force_to_0, Thread current_thread)
	See PipelineCyclerBase::elevate_read_upstream(). More...

void	operator= (const PipelineCycler< CycleDataType > &copy)

const CycleDataType *	read (Thread *current_thread) const
	See PipelineCyclerBase::read(). More...

const CycleDataType *	read_stage (int pipeline_stage, Thread *current_thread) const
	See PipelineCyclerBase::read_stage(). More...

const CycleDataType *	read_stage_unlocked (int pipeline_stage) const
	See PipelineCyclerBase::read_stage_unlocked(). More...

const CycleDataType *	read_unlocked (Thread *current_thread) const
	See PipelineCyclerBase::read_unlocked(). More...

CycleDataType *	write (Thread *current_thread)
	See PipelineCyclerBase::write(). More...

CycleDataType *	write_stage (int pipeline_stage, Thread *current_thread)
	See PipelineCyclerBase::write_stage(). More...

CycleDataType *	write_stage_upstream (int pipeline_stage, bool force_to_0, Thread *current_thread)
	See PipelineCyclerBase::write_stage_upstream(). More...

CycleDataType *	write_upstream (bool force_to_0, Thread *current_thread)
	See PipelineCyclerBase::write_upstream(). More...

Public Member Functions inherited from PipelineCyclerTrivialImpl
	PipelineCyclerTrivialImpl (CycleData initial_data, Pipeline pipeline=nullptr)

	PipelineCyclerTrivialImpl (const PipelineCyclerTrivialImpl &copy)=delete

void	acquire (Thread *current_thread=nullptr)
	Grabs an overall lock on the cycler. More...

CycleData *	cheat () const
	Returns a pointer without counting it. More...

CycleData *	elevate_read (const CycleData pointer, Thread current_thread)
	Elevates a currently-held read pointer into a write pointer. More...

CycleData *	elevate_read_stage (int pipeline_stage, const CycleData pointer, Thread current_thread)
	Elevates a currently-held read pointer into a write pointer. More...

CycleData *	elevate_read_stage_upstream (int pipeline_stage, const CycleData pointer, bool force_to_0, Thread current_thread)
	Elevates a currently-held read pointer into a write pointer. More...

CycleData *	elevate_read_upstream (const CycleData pointer, bool force_to_0, Thread current_thread)
	Elevates a currently-held read pointer into a write pointer, like elevate_read(), but also propagates the pointer back to upstream stages, like write_upstream(). More...

int	get_num_stages ()
	Returns the number of stages in the pipeline. More...

TypeHandle	get_parent_type () const
	Returns the type of object that owns this cycler, as reported by CycleData::get_parent_type(). More...

int	get_read_count () const
	Returns the number of handles currently outstanding to read the current stage of the data. More...

int	get_write_count () const
	Returns the number of handles currently outstanding to read the current stage of the data. More...

void	increment_read (const CycleData *pointer) const
	Increments the count on a pointer previously retrieved by read(); now the pointer will need to be released twice. More...

void	increment_write (CycleData *pointer) const
	Increments the count on a pointer previously retrieved by write(); now the pointer will need to be released twice. More...

PipelineCyclerTrivialImpl &	operator= (const PipelineCyclerTrivialImpl &copy)=delete

const CycleData *	read (Thread *current_thread) const
	Returns a const CycleData pointer, filled with the data for the current stage of the pipeline as seen by this thread. More...

const CycleData *	read_stage (int pipeline_stage, Thread *current_thread) const
	Returns a const CycleData pointer, filled with the data for the indicated pipeline stage. More...

const CycleData *	read_stage_unlocked (int pipeline_stage) const
	Returns a const CycleData pointer, filled with the data for the indicated stage of the pipeline. More...

const CycleData *	read_unlocked (Thread *current_thread) const
	Returns a const CycleData pointer, filled with the data for the current stage of the pipeline as seen by this thread. More...

void	release ()
	Release the overall lock on the cycler that was grabbed via acquire(). More...

void	release_read (const CycleData *pointer) const
	Releases a pointer previously obtained via a call to read(). More...

void	release_read_stage (int pipeline_stage, const CycleData *pointer) const
	Releases a pointer previously obtained via a call to read_stage(). More...

void	release_write (CycleData *pointer)
	Releases a pointer previously obtained via a call to write(). More...

void	release_write_stage (int pipeline_stage, CycleData *pointer)
	Releases a pointer previously obtained via a call to write_stage(). More...

CycleData *	write (Thread *current_thread)
	Returns a non-const CycleData pointer, filled with a unique copy of the data for the current stage of the pipeline as seen by this thread. More...

CycleData *	write_stage (int pipeline_stage, Thread *current_thread)
	Returns a pointer suitable for writing to the nth stage of the pipeline. More...

CycleData *	write_stage_upstream (int pipeline_stage, bool force_to_0, Thread *current_thread)
	Returns a pointer suitable for writing to the nth stage of the pipeline. More...

CycleData *	write_upstream (bool force_to_0, Thread *current_thread)
	This special variant on write() will automatically propagate changes back to upstream pipeline stages. More...

Additional Inherited Members
Public Attributes inherited from PipelineCyclerTrivialImpl
CycleData *	_data

Detailed Description

template<class CycleDataType>
struct PipelineCycler< CycleDataType >

This class maintains different copies of a page of data between stages of the graphics pipeline (or any other pipelining context).

The class object maintains up to n copies of a CycleData structure, one for each stage of the pipeline. The head of the pipeline is responsible for making changes to its copy, which are then cycled through the pipeline at each frame.

To access the data, you must first ask for a readable pointer. In order to make changes to the data, you must ask for a writable pointer. Both kinds of pointers should be released when you are done, as a sanity check. The CycleDataReader and CycleDataWriter classes transparently handle this.

If pipelining support is not enabled at compile time (that is, DO_PIPELINING is not defined), this object compiles to a minimum object that presents the same interface but with minimal runtime overhead.

We define this as a struct instead of a class to guarantee byte placement within the object, so that (particularly for the trivial implementation) the inherited struct's data is likely to be placed by the compiler at the "this" pointer.

Definition at line 46 of file pipelineCycler.h.

Member Function Documentation

◆ cheat()

template<class CycleDataType >

CycleDataType * PipelineCycler< CycleDataType >::cheat ( ) const

inline

Returns a pointer without counting it.

This is only intended for use as the return value for certain nassertr() functions, so the application can recover after a failure to manage the read and write pointers correctly. You should never call this function directly.

Definition at line 342 of file pipelineCycler.I.

◆ elevate_read()

template<class CycleDataType>

CycleDataType * PipelineCycler< CycleDataType >::elevate_read	(	const CycleDataType *	pointer,
		Thread *	current_thread
	)

inline

See PipelineCyclerBase::elevate_read().

Definition at line 267 of file pipelineCycler.I.

◆ elevate_read_stage()

template<class CycleDataType>

CycleDataType * PipelineCycler< CycleDataType >::elevate_read_stage	(	int	pipeline_stage,
		const CycleDataType *	pointer,
		Thread *	current_thread
	)

inline

See PipelineCyclerBase::elevate_read_stage().

Definition at line 303 of file pipelineCycler.I.

◆ elevate_read_stage_upstream()

template<class CycleDataType>

CycleDataType * PipelineCycler< CycleDataType >::elevate_read_stage_upstream	(	int	pipeline_stage,
		const CycleDataType *	pointer,
		bool	force_to_0,
		Thread *	current_thread
	)