Gfx Namespace Reference

Binds the rendering pipeline to ossia processes. More...

Detailed Description

Binds the rendering pipeline to ossia processes.

This namespace contains the machinery that ties the rendering features provided by score::gfx to the ossia execution engine and data model.

It works as follows:

• Every time processes execute, visual processes will mark themselves as executed, by notifying Gfx::GfxExecutionAction.

  This is necessary because the visual graph is dynamic: processes can come on and off at any point during execution.

• After all the ossia execution graph nodes have executed, the new edges between nodes are sent to the graphics processing thread, to Gfx::GfxContext.
• This thread regularly updates the graph with the incoming information, either before VSync if VSync is enabled or with a timer otherwise:
  • Edges are updated with the currently running nodes in the score
  • Parameters, audio data... sent to the ossia processes in the execution graph are converted into uniforms corresponding to the shaders used, and uploaded to the GPU.

Classes
struct	ACodecInfo
class	ApplicationPlugin
class	AssetTable
	Cross-RenderList content-hash dedup for decoded asset bytes. More...
struct	AudioFrameEncoder
class	background_device
class	BasicRenderer
class	CameraDevice
struct	CameraDeviceEnumerator
class	CameraPreviewWidget
	Live preview of a Video::ExternalInput, for device settings dialogs. More...
class	CameraProtocolFactory
struct	CameraSettings
class	CaptureControlTree
	Builds /render/ for one capture stream. More...
class	ChangeCSF
class	ChangeRenderPipelineShader
class	ChangeShader
class	ChangeVSAShader
struct	clear_msg_visitor
class	CollapsibleSection
struct	con_unvalidated
struct	CornerWarp
struct	DblIAudioFrameEncoder
struct	DblPAudioFrameEncoder
struct	DemuxerInfo
class	DesktopLayoutCanvas
class	DesktopLayoutItem
class	DeviceBackgroundRenderer
class	DocumentPlugin
struct	DShowCameraDeviceEnumerator
struct	DShowCameraEnumerator
struct	EdgeBlend
struct	EdgeSpec
struct	exec_control
class	filter_node
class	FlatHeaderButton
struct	FltIAudioFrameEncoder
struct	FltPAudioFrameEncoder
class	GeometryInlet
struct	GeometryInletFactory
class	GeometryOutlet
struct	GeometryOutletFactory
class	gfx_exec_node
class	gfx_node_base
class	gfx_parameter_base
class	gfx_protocol_base
class	GfxContext
class	GfxExecutionAction
class	GfxInputDevice
class	GfxOutputDevice
class	GraphPreviewWidget
struct	ImageCache
class	InvertYRenderer
class	ISFExecutorComponent
struct	ISFHelpers
class	libav_input_audio_parameter
class	libav_input_device
class	libav_input_protocol
class	libav_output_device
class	libav_output_protocol
class	libav_record_audio_parameter
class	LibavDevice
struct	LibavEncoder
struct	LibavEncoderNode
struct	LibavIntrospection
struct	LibavOutputSettings
class	LibavProtocolFactory
struct	LibavSettings
class	LibavSettingsWidget
class	multi_texture_input_device
class	multi_texture_input_node
	Root of a device exposing several texture streams. More...
class	multiwindow_device
struct	MuxerInfo
class	offscreen_device
class	OutletPreviewLayer
struct	OutputMapping
class	OutputMappingCanvas
class	OutputMappingItem
class	OutputPreviewWindows
struct	OutputStream
struct	pointer_addresses
class	PreviewWidget
struct	ProcessedProgram
struct	ProgramCache
struct	ProgramCacheKey
class	RawRasterDropHandler
class	RawRasterLibraryHandler
class	RhiPreviewWidget
	A QWidget that paints a score::gfx render-graph output without using QWidget::createWindowContainer (broken on macOS) or QRhiWidget (forces the toplevel to switch to RHI compositing — flash + perf impact). More...
struct	S16IAudioFrameEncoder
struct	S16PAudioFrameEncoder
struct	S24IAudioFrameEncoder
struct	S32IAudioFrameEncoder
struct	S32PAudioFrameEncoder
class	ScaledRenderer
class	sh4lt_output_device
class	Sh4ltOutputDevice
struct	Sh4ltOutputNode
class	Sh4ltOutputProtocolFactory
class	Sh4ltOutputSettingsWidget
class	ShaderPreviewManager
class	ShaderPreviewWidget
class	ShaderSamplerSource
struct	ShaderSource
class	SharedInputProtocolFactory
struct	SharedInputSettings
class	SharedInputSettingsWidget
class	SharedOutputProtocolFactory
struct	SharedOutputSettings
class	SharedOutputSettingsWidget
class	shmdata_output_device
class	ShmdataOutputDevice
struct	ShmdataOutputNode
class	ShmdataOutputProtocolFactory
class	ShmdataOutputSettingsWidget
class	simple_texture_input_device
class	simple_texture_input_node
class	simple_texture_input_parameter
class	simple_texture_input_protocol
class	SpoutDevice
struct	SpoutNode
class	SpoutProtocolFactory
class	SpoutSettingsWidget
struct	StreamOptions
class	SyphonDevice
class	SyphonProtocolFactory
class	SyphonSettingsWidget
class	texture_input_stream_node
	One stream of a device that exposes several. More...
class	TextureOutletBackgroundRenderer
	What a selected texture outlet produces, behind the editor. More...
class	TextureOutletBackgroundRendererFactory
class	TexturePreview
	What a texture outlet produces, as an image any view can paint: an inspector widget, an item of the scene. More...
struct	TextureSizeWidget
struct	TreeControl
	One settable thing, described independently of where it came from. More...
struct	V4L2CameraDeviceEnumerator
struct	V4L2CameraEnumerator
struct	VCodecInfo
class	video_texture_input_device
class	video_texture_input_node
class	video_texture_input_parameter
class	video_texture_input_protocol
class	window_device
class	WindowDevice
struct	WindowOutputSettings
class	WindowProtocolFactory
struct	WindowSettings
class	WindowSettingsWidget

Typedefs
using	av_input_video_type = decltype(av_input_video_device_next(nullptr))
using	port_index = ossia::gfx::port_index
using	exec_controls = std::vector< std::shared_ptr< exec_control > >

Enumerations
enum class	ShaderFamily {   Unknown , RawRaster , GeometryFilter , Compute ,   VertexShaderArt }
enum class	PreviewContent { Black , PerOutputTestCard , GlobalTestCard , OutputIdentification }
enum class	WindowMode : int { Single = 0 , Background = 1 , MultiWindow = 2 }
enum class	SwapchainFlag : int { NoFlag = 0 , sRGB = (1 << 2) }
enum class	SwapchainFormat : int { SDR , HDRExtendedSrgbLinear , HDR10 , HDRExtendedDisplayP3Linear }
enum class	OutputLockMode : int { Free = 0 , AspectRatio = 1 , OneToOne = 2 , FullLock = 3 }

Functions
std::shared_ptr< CameraDeviceEnumerator >	make_camera_enumerator ()
std::string	cameraFormatName (int codec, int pixelformat) noexcept
const CommandGroupKey &	CommandFactoryName ()
std::vector< ossia::net::parameter_base * >	addControlGroup (ossia::net::device_base &dev, ossia::net::node_base &parent, const std::string &group, const std::vector< TreeControl > &controls)
	Creates <parent>/<group>/<name> for each control.
template<typename Vector >
int64_t	index_of (Vector &&v, const typename std::remove_reference_t< Vector >::value_type &t)
ossia::value	fromImageSet (const std::span< score::gfx::Image > &images)
void	releaseImages (std::vector< score::gfx::Image > &imgs)
std::vector< score::gfx::Image >	getImages (const ossia::value &val, const score::DocumentContext &ctx)
Process::ControlInlet *	makeLongInputControl (const isf::long_input &v, const QString &name, Id< Process::Port > id, QObject *parent)
	The control of an ISF / CSF / geometry-filter long input.
void	updateToGlsl45 (ShaderSource &program)
ShaderFamily	shaderFileFamily (const QString &path) noexcept
QString	vertexShaderSibling (const QString &fsPath) noexcept
QString	fragmentShaderSibling (const QString &vsPath) noexcept
QString	locateShaderPath (const QString &path, const QObject &process) noexcept
ShaderSource	programFromISFFragmentShaderPath (const QString &fsFilename, QByteArray fsData, ShaderSource::ProgramType type=ShaderSource::ProgramType::ISF)
ShaderSource	programFromVSAVertexShaderPath (const QString &vertexFilename, QByteArray vertexData)
std::pair< QByteArray, QString >	preprocessShaderIncludes (QByteArray source, const QString &originPath={}) noexcept
void	logShaderError (const QObject &process, const QString &error) noexcept
const isf::sampler_config *	declaredSampler (const isf::descriptor &desc, const QString &name) noexcept
	The sampler desc declares for its input named name, or null.
CGLContextObj	nativeContext (QRhi &rhi)
score::gfx::OutputNode *	makeSyphonOutput (const SharedOutputSettings &s)
	MODEL_METADATA_IMPL_CPP (TextureInlet)
	MODEL_METADATA_IMPL_CPP (TextureOutlet)
QImage	renderTestCard (int w, int h)
QPoint	windowPositionForSource (QPoint p) noexcept
	Where to put the window of an output whose source starts at p.

Variables
ShaderPreviewManager *	g_shaderPreview {}
bool	g_shaderPreviewScheduledForDeletion {}

Enumeration Type Documentation

ShaderFamily

enum class Gfx::ShaderFamily

strong

Which of the shader families a file on disk belongs to, read from the "MODE" key of its ISF header. Unknown is a shader with no such key: an ISF without MODE, a bare GLSL snippet, a hand-written companion vertex shader. Deciding this is what lets several drop handlers share an extension: each one claims its own family and leaves the rest alone.

Function Documentation

addControlGroup()

std::vector< ossia::net::parameter_base * > Gfx::addControlGroup ( ossia::net::device_base &  dev, ossia::net::node_base &  parent, const std::string &  group, const std::vector< TreeControl > &  controls  )

inline

Creates <parent>/<group>/<name> for each control.

Returns

the created parameters, in the order of controls, so the caller can push values back into them later. An entry is null when its node could not be created – a name collision, in practice.

cameraFormatName()

std::string Gfx::cameraFormatName ( int  codec, int  pixelformat  )

inlinenoexcept

The name a camera format is offered under in the device list.

A compressed stream carries no pixel format, a raw one no codec: the codec names the former, the layout the latter. Both lookups can answer nullptr, so neither is assigned to the string unchecked.

fragmentShaderSibling()

QString Gfx::fragmentShaderSibling ( const QString &  vsPath )

noexcept

Path of the fragment shader vsPath is the companion of, or an empty string. A vertex shader that has one is not a standalone process.

locateShaderPath()

QString Gfx::locateShaderPath ( const QString &  path, const QObject &  process  )

noexcept

Absolute path of the shader a process was created with. Construction data travels as a <PROJECT>: / <LIBRARY>: path so that it survives a project being moved; the model needs the resolved one, like the load path does.

logShaderError()

void Gfx::logShaderError ( const QObject &  process, const QString &  error  )

noexcept

Logs, as a warning naming process, that its shader could not be used. For the shader processes' setProgram / setScript, which a document load runs: their errorMessage signal only reaches an open script editor.

makeLongInputControl()

Process::ControlInlet * Gfx::makeLongInputControl ( const isf::long_input &  v, const QString &  name, Id< Process::Port >  id, QObject *  parent  )

inline

The control of an ISF / CSF / geometry-filter long input.

With VALUES it is a ComboBox whose entries carry those values (LABELS name them when there are as many), initially on the entry def indexes. Without VALUES it is an IntSpinBox over whichever of MIN and MAX are given, the int range on a side that is not, starting at def: a bare long used to become an arbitrary 0 / 1 / 2 ComboBox, and one with a single bound too (shader board U11).

makeSyphonOutput()

score::gfx::OutputNode * Gfx::makeSyphonOutput

(

const SharedOutputSettings &

s

)

Headless factory for the Syphon publishing node, so a test harness can drive the real output without the Device / Document machinery – the same hook Gfx::PipeWire::makePipewireOutput provides.

updateToGlsl45()

void Gfx::updateToGlsl45

(

ShaderSource &

program

)

Gives the varyings a generated ISF stage pair declares without a layout their locations, from 1 in declaration order, the fragment inputs taking the location of the vertex output of the same name.

vertexShaderSibling()

QString Gfx::vertexShaderSibling ( const QString &  fsPath )

noexcept

Path of the vertex shader that goes with fsPath – foo.vert or foo.vs next to foo.fs / foo.frag – or an empty string.

windowPositionForSource()

QPoint Gfx::windowPositionForSource ( QPoint  p )

inlinenoexcept

Where to put the window of an output whose source starts at p.

The desktop origin is a bad place for a window: it is hard to grab by its title bar on Windows, and a tiling window manager may not map it at all – on i3 the first output window stayed invisible until it was moved by one pixel. Only that exact spot is moved; anywhere else is left alone.