SnapSink::Config Struct Reference

The SnapSink configuration structure. More...

Public Attributes
AllocationStrategy	allocationStrategy
	Specifies the sink's buffer allocation strategy.
CustomAllocationStrategy	customAllocationStrategy
	Specifies the custom allocation strategy.
std::shared_ptr< BufferAllocator >	bufferAllocator
	A std::shared_ptr to a BufferAllocator that replaces sink's default allocator.
std::vector< PixelFormat >	acceptedPixelFormats
	An array of possible pixel formats that the sink can receive.

Detailed Description

The SnapSink configuration structure.

Passed to SnapSink::create(const Config&, Error&) to configure the sink's behavior.

Member Data Documentation

acceptedPixelFormats

std::vector<PixelFormat> acceptedPixelFormats

An array of possible pixel formats that the sink can receive.

If the vector is empty, all pixel formats are accepted.

allocationStrategy

AllocationStrategy allocationStrategy

Specifies the sink's buffer allocation strategy.

The buffer allocation strategy defines how many buffers are pre-allocated, when additional buffers are created, and when excess buffers are reclaimed.

bufferAllocator

std::shared_ptr<BufferAllocator> bufferAllocator

A std::shared_ptr to a BufferAllocator that replaces sink's default allocator.

If this is nullptr, a default allocator is used.

customAllocationStrategy

CustomAllocationStrategy customAllocationStrategy

Specifies the custom allocation strategy.

This member is ignored unless allocationStrategy is equal to AllocationStrategy::Custom.