CompressionSettingsBuilder Class Reference

A modifiable type used to create an immutable CompressionSettings More...

Public Member Functions
	CompressionSettingsBuilder (CompressionSettings data)
	Creates a builder with the values of an existing immutable instance More...
CompressionSettings	Build ()
	Creates a new CompressionSettings immutable object from this one. More...

Properties
CompressionId	CompressionIds [get, set]
	Mask that represents the compression algorithms enabled. More...
uint	WriterCompressionLevel [get, set]
	The level of compression to use when compressing data. More...
int	WriterCompressionThreshold [get, set]
	The threshold, in bytes, above which a serialized sample will be eligible to be compressed. More...

Detailed Description

A modifiable type used to create an immutable CompressionSettings

Constructor & Destructor Documentation

CompressionSettingsBuilder()

CompressionSettingsBuilder

(

CompressionSettings

data

)

Creates a builder with the values of an existing immutable instance

Member Function Documentation

Build()

CompressionSettings Build

(

)

Creates a new CompressionSettings immutable object from this one.

Property Documentation

CompressionIds

CompressionId CompressionIds

getset

Mask that represents the compression algorithms enabled.

The full documentation is available in the C API: DDS_CompressionSettings_t::compression_ids

WriterCompressionLevel

uint WriterCompressionLevel

getset

The level of compression to use when compressing data.

The full documentation is available in the C API: DDS_CompressionSettings_t::writer_compression_level

WriterCompressionThreshold

int WriterCompressionThreshold

getset

The threshold, in bytes, above which a serialized sample will be eligible to be compressed.

The full documentation is available in the C API: DDS_CompressionSettings_t::writer_compression_threshold