RenderPipeline. More...

#include "gpuCommandList.h"

Public Member Functions
	GPUCommandList ()
	RenderPipeline. More...

void	add_command (const GPUCommand &cmd)
	Pushes a GPUCommand to the command list. More...

size_t	get_num_commands ()

size_t	write_commands_to (const PTA_uchar &dest, size_t limit=32)
	Writes the first n-commands to a destination. More...

Public Attributes
	get_num_commands
	Returns the number of commands in this list. More...

Detailed Description

RenderPipeline.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Class to store a list of commands.

This is a class to store a list of GPUCommands. It provides functionality to only provide the a given amount of commands at one time.

Definition at line 40 of file gpuCommandList.h.

Constructor & Destructor Documentation

◆ GPUCommandList()

GPUCommandList::GPUCommandList ( )

RenderPipeline.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Constructs a new GPUCommandList

This constructs a new GPUCommandList. By default, there are no commands in the list.

Definition at line 35 of file gpuCommandList.cxx.

Member Function Documentation

◆ add_command()

void GPUCommandList::add_command ( const GPUCommand & cmd )

Pushes a GPUCommand to the command list.

This adds a new GPUCommand to the list of commands to be processed.

Parameters

cmd	The command to add

Definition at line 44 of file gpuCommandList.cxx.

◆ write_commands_to()

size_t GPUCommandList::write_commands_to	(	const PTA_uchar &	dest,
		size_t	limit = `32`
	)

Writes the first n-commands to a destination.

This takes the first #limit commands, and writes them to the destination using GPUCommand::write_to. See GPUCommand::write_to for further information about #dest. The limit controls after how much commands the processing will be stopped. All commands which got processed will get removed from the list.

Parameters

dest	Destination to write to, see GPUCommand::write_to
limit	Maximum amount of commands to process

Returns: Amount of commands processed, between 0 and #limit.

Definition at line 71 of file gpuCommandList.cxx.

Member Data Documentation

◆ get_num_commands

size_t GPUCommandList::get_num_commands

Returns the number of commands in this list.

This returns the amount of commands which are currently stored in this list, and are waiting to get processed.

Returns: Amount of commands

Definition at line 48 of file gpuCommandList.h.

The documentation for this class was generated from the following files:

contrib/src/rplight/gpuCommandList.h
contrib/src/rplight/gpuCommandList.cxx

Public Member Functions

Public Attributes