librepcb::rs Namespace Reference

Classes
struct	InteractiveHtmlBomPad
struct	InteractiveHtmlBomRefMap

Enumerations
enum class	InteractiveHtmlBomDrawingKind
enum class	InteractiveHtmlBomDrawingLayer
enum class	InteractiveHtmlBomHighlightPin1Mode
enum class	InteractiveHtmlBomLayer
enum class	InteractiveHtmlBomSides
enum class	InteractiveHtmlBomViewMode

Functions
std::size_t	ffi_qbytearray_len (const QByteArray *obj)
const uint8_t *	ffi_qbytearray_data (const QByteArray *obj)
uint8_t *	ffi_qbytearray_data_mut (QByteArray *obj)
void	ffi_qbytearray_resize (QByteArray *obj, std::size_t len, uint8_t value)
std::size_t	ffi_qstring_len (const QString *obj)
const uint16_t *	ffi_qstring_utf16 (const QString *obj)
void	ffi_qstring_set (QString *obj, const char *s, std::size_t len)
std::size_t	ffi_qstringlist_len (const QStringList *obj)
const QString *	ffi_qstringlist_at (const QStringList *obj, std::size_t index)
size_t	ffi_qbytearray_len (const QByteArray *NONNULL obj)
const uint8_t *	ffi_qbytearray_data (const QByteArray *NONNULL obj)
uint8_t *	ffi_qbytearray_data_mut (QByteArray *NONNULL obj)
void	ffi_qbytearray_resize (QByteArray *NONNULL obj, size_t len, uint8_t value)
size_t	ffi_qstring_len (const QString *NONNULL obj)
const uint16_t *	ffi_qstring_utf16 (const QString *NONNULL obj)
void	ffi_qstring_set (QString *NONNULL obj, const char *s, size_t len)
size_t	ffi_qstringlist_len (const QStringList *NONNULL obj)
const QString *	ffi_qstringlist_at (const QStringList *NONNULL obj, size_t index)
InteractiveHtmlBom *	ffi_ibom_new (const QString *NONNULL title, const QString *NONNULL company, const QString *NONNULL revision, const QString *NONNULL date, float bottom_left_x, float bottom_left_y, float top_right_x, float top_right_y)
void	ffi_ibom_delete (InteractiveHtmlBom *obj)
void	ffi_ibom_set_view_config (InteractiveHtmlBom *NONNULL obj, InteractiveHtmlBomViewMode mode, InteractiveHtmlBomHighlightPin1Mode highlight_pin1, bool dark)
void	ffi_ibom_set_rotation (InteractiveHtmlBom *NONNULL obj, float angle, bool offset_back)
void	ffi_ibom_set_show_silkscreen (InteractiveHtmlBom *NONNULL obj, bool show)
void	ffi_ibom_set_show_fabrication (InteractiveHtmlBom *NONNULL obj, bool show)
void	ffi_ibom_set_show_pads (InteractiveHtmlBom *NONNULL obj, bool show)
void	ffi_ibom_set_checkboxes (InteractiveHtmlBom *NONNULL obj, const QStringList *NONNULL checkboxes)
void	ffi_ibom_set_fields (InteractiveHtmlBom *NONNULL obj, const QStringList *NONNULL fields)
void	ffi_ibom_add_drawing (InteractiveHtmlBom *NONNULL obj, InteractiveHtmlBomDrawingKind kind, InteractiveHtmlBomDrawingLayer layer, const QString *NONNULL svgpath, float width, bool filled)
size_t	ffi_ibom_add_footprint (InteractiveHtmlBom *NONNULL obj, InteractiveHtmlBomLayer layer, float pos_x, float pos_y, float angle, float bottom_left_x, float bottom_left_y, float top_right_x, float top_right_y, bool mount, const QStringList *NONNULL fields, const InteractiveHtmlBomPad *pads_array, size_t pads_size)
void	ffi_ibom_add_bom_line (InteractiveHtmlBom *NONNULL obj, InteractiveHtmlBomSides sides, const InteractiveHtmlBomRefMap *parts_array, size_t parts_size)
void	ffi_ibom_add_track (InteractiveHtmlBom *NONNULL obj, InteractiveHtmlBomLayer layer, float start_x, float start_y, float end_x, float end_y, float width, const QString *net_name)
void	ffi_ibom_add_via (InteractiveHtmlBom *NONNULL obj, const InteractiveHtmlBomLayer *layers_array, size_t layers_size, float pos_x, float pos_y, float diameter, float drill_diameter, const QString *net_name)
void	ffi_ibom_add_zone (InteractiveHtmlBom *NONNULL obj, InteractiveHtmlBomLayer layer, const QString *NONNULL svgpath, const QString *net_name)
bool	ffi_ibom_generate_html (const InteractiveHtmlBom *NONNULL obj, QString *NONNULL out, QString *NONNULL err)
void	ffi_increment_number_in_string (QString *NONNULL s)
ZipArchive *	ffi_ziparchive_new_from_file (const QString *NONNULL path, QString *NONNULL err)
ZipArchive *	ffi_ziparchive_new_from_mem (const QByteArray *NONNULL data, QString *NONNULL err)
void	ffi_ziparchive_delete (ZipArchive *obj)
size_t	ffi_ziparchive_len (const ZipArchive *NONNULL obj)
bool	ffi_ziparchive_name_for_index (ZipArchive *NONNULL obj, size_t index, QString *NONNULL name, QString *NONNULL err)
bool	ffi_ziparchive_read_by_index (ZipArchive *NONNULL obj, size_t index, QByteArray *NONNULL buf, QString *NONNULL err)
bool	ffi_ziparchive_extract (ZipArchive *NONNULL obj, const QString *NONNULL dir)
ZipWriter *	ffi_zipwriter_new_to_file (const QString *NONNULL path, QString *NONNULL err)
ZipWriter *	ffi_zipwriter_new_to_mem (QByteArray *NONNULL data)
void	ffi_zipwriter_delete (ZipWriter *obj)
bool	ffi_zipwriter_write_file (ZipWriter *NONNULL obj, const QString *NONNULL name, const QByteArray *NONNULL data, uint32_t mode, QString *NONNULL err)
bool	ffi_zipwriter_finish (ZipWriter *NONNULL obj, QString *NONNULL err)

Enumeration Type Documentation

InteractiveHtmlBomDrawingKind

enum class InteractiveHtmlBomDrawingKind

strong

Wrapper for [DrawingKind]

Enumerator
Polygon	Polygon
ReferenceText	Component reference designator text
ValueText	Component value text

InteractiveHtmlBomDrawingLayer

enum class InteractiveHtmlBomDrawingLayer

strong

Wrapper for [DrawingLayer]

Enumerator
Edge	PCB edge
SilkscreenFront	Silkscreen front
SilkscreenBack	Silkscreen back
FabricationFront	Fabrication front
FabricationBack	Fabrication back

InteractiveHtmlBomHighlightPin1Mode

enum class InteractiveHtmlBomHighlightPin1Mode

strong

Wrapper for [HighlightPin1Mode]

Enumerator
None	No pins
Selected	Selected pins
All	All pins

InteractiveHtmlBomLayer

enum class InteractiveHtmlBomLayer

strong

Wrapper for [Layer]

Enumerator
Front	Front layer
Back	Back layer

InteractiveHtmlBomSides

enum class InteractiveHtmlBomSides

strong

Enum to define board side(s)

Enumerator
Front	Front
Back	Back
Both	Front + Back

InteractiveHtmlBomViewMode

enum class InteractiveHtmlBomViewMode

strong

Wrapper for [ViewMode]

Enumerator
BomOnly	BOM only
LeftRight	BOM left, drawings right
TopBottom	BOM top, drawings bottom

Function Documentation

ffi_qbytearray_len() [1/2]

std::size_t ffi_qbytearray_len

(

const QByteArray *

obj

)

ffi_qbytearray_data() [1/2]

const uint8_t * ffi_qbytearray_data

(

const QByteArray *

obj

)

ffi_qbytearray_data_mut() [1/2]

uint8_t * ffi_qbytearray_data_mut

(

QByteArray *

obj

)

ffi_qbytearray_resize() [1/2]

void ffi_qbytearray_resize	(	QByteArray *	obj,
		std::size_t	len,
		uint8_t	value
	)

ffi_qstring_len() [1/2]

std::size_t ffi_qstring_len

(

const QString *

obj

)

ffi_qstring_utf16() [1/2]

const uint16_t * ffi_qstring_utf16

(

const QString *

obj

)

ffi_qstring_set() [1/2]

void ffi_qstring_set	(	QString *	obj,
		const char *	s,
		std::size_t	len
	)

ffi_qstringlist_len() [1/2]

std::size_t ffi_qstringlist_len

(

const QStringList *

obj

)

ffi_qstringlist_at() [1/2]

const QString * ffi_qstringlist_at	(	const QStringList *	obj,
		std::size_t	index
	)

ffi_qbytearray_len() [2/2]

size_t ffi_qbytearray_len ( const QByteArray *NONNULL  obj )

extern

ffi_qbytearray_data() [2/2]

const uint8_t * ffi_qbytearray_data ( const QByteArray *NONNULL  obj )

extern

ffi_qbytearray_data_mut() [2/2]

uint8_t * ffi_qbytearray_data_mut ( QByteArray *NONNULL  obj )

extern

ffi_qbytearray_resize() [2/2]

void ffi_qbytearray_resize ( QByteArray *NONNULL  obj, size_t  len, uint8_t  value  )

extern

ffi_qstring_len() [2/2]

size_t ffi_qstring_len ( const QString *NONNULL  obj )

extern

ffi_qstring_utf16() [2/2]

const uint16_t * ffi_qstring_utf16 ( const QString *NONNULL  obj )

extern

ffi_qstring_set() [2/2]

void ffi_qstring_set ( QString *NONNULL  obj, const char *  s, size_t  len  )

extern

ffi_qstringlist_len() [2/2]

size_t ffi_qstringlist_len ( const QStringList *NONNULL  obj )

extern

ffi_qstringlist_at() [2/2]

const QString * ffi_qstringlist_at ( const QStringList *NONNULL  obj, size_t  index  )

extern

ffi_ibom_new()

InteractiveHtmlBom * ffi_ibom_new	(	const QString *NONNULL	title,
		const QString *NONNULL	company,
		const QString *NONNULL	revision,
		const QString *NONNULL	date,
		float	bottom_left_x,
		float	bottom_left_y,
		float	top_right_x,
		float	top_right_y
	)

Create a new [InteractiveHtmlBom] object

Here is the caller graph for this function:

ffi_ibom_delete()

void ffi_ibom_delete

(

InteractiveHtmlBom *

obj

)

Delete [InteractiveHtmlBom] object

Here is the caller graph for this function:

ffi_ibom_set_view_config()

void ffi_ibom_set_view_config	(	InteractiveHtmlBom *NONNULL	obj,
		InteractiveHtmlBomViewMode	mode,
		InteractiveHtmlBomHighlightPin1Mode	highlight_pin1,
		bool	dark
	)

Wrapper to set [InteractiveHtmlBom::view_mode], [InteractiveHtmlBom::dark_mode] and [InteractiveHtmlBom::highlight_pin1]

Here is the caller graph for this function:

ffi_ibom_set_rotation()

void ffi_ibom_set_rotation	(	InteractiveHtmlBom *NONNULL	obj,
		float	angle,
		bool	offset_back
	)

Wrapper to set [InteractiveHtmlBom::board_rotation] and [InteractiveHtmlBom::offset_back_rotation]

Here is the caller graph for this function:

ffi_ibom_set_show_silkscreen()

void ffi_ibom_set_show_silkscreen	(	InteractiveHtmlBom *NONNULL	obj,
		bool	show
	)

Wrapper to set [InteractiveHtmlBom::show_silkscreen]

Here is the caller graph for this function:

ffi_ibom_set_show_fabrication()

void ffi_ibom_set_show_fabrication	(	InteractiveHtmlBom *NONNULL	obj,
		bool	show
	)

Wrapper to set [InteractiveHtmlBom::show_fabrication]

Here is the caller graph for this function:

ffi_ibom_set_show_pads()

void ffi_ibom_set_show_pads	(	InteractiveHtmlBom *NONNULL	obj,
		bool	show
	)

Wrapper to set [InteractiveHtmlBom::show_pads]

Here is the caller graph for this function:

ffi_ibom_set_checkboxes()

void ffi_ibom_set_checkboxes	(	InteractiveHtmlBom *NONNULL	obj,
		const QStringList *NONNULL	checkboxes
	)

Wrapper to set [InteractiveHtmlBom::checkboxes]

Here is the caller graph for this function:

ffi_ibom_set_fields()

void ffi_ibom_set_fields	(	InteractiveHtmlBom *NONNULL	obj,
		const QStringList *NONNULL	fields
	)

Wrapper to set [InteractiveHtmlBom::fields]

Here is the caller graph for this function:

ffi_ibom_add_drawing()

void ffi_ibom_add_drawing	(	InteractiveHtmlBom *NONNULL	obj,
		InteractiveHtmlBomDrawingKind	kind,
		InteractiveHtmlBomDrawingLayer	layer,
		const QString *NONNULL	svgpath,
		float	width,
		bool	filled
	)

Wrapper for adding a drawing to [InteractiveHtmlBom::drawings]

Here is the caller graph for this function:

ffi_ibom_add_footprint()

size_t ffi_ibom_add_footprint	(	InteractiveHtmlBom *NONNULL	obj,
		InteractiveHtmlBomLayer	layer,
		float	pos_x,
		float	pos_y,
		float	angle,
		float	bottom_left_x,
		float	bottom_left_y,
		float	top_right_x,
		float	top_right_y,
		bool	mount,
		const QStringList *NONNULL	fields,
		const InteractiveHtmlBomPad *	pads_array,
		size_t	pads_size
	)

Wrapper for [InteractiveHtmlBom::add_footprint]

Here is the caller graph for this function:

ffi_ibom_add_bom_line()

void ffi_ibom_add_bom_line	(	InteractiveHtmlBom *NONNULL	obj,
		InteractiveHtmlBomSides	sides,
		const InteractiveHtmlBomRefMap *	parts_array,
		size_t	parts_size
	)

Wrapper to add BOM lines to [InteractiveHtmlBom::bom_front], [InteractiveHtmlBom::bom_back] or [InteractiveHtmlBom::bom_both]

Here is the caller graph for this function:

ffi_ibom_add_track()

void ffi_ibom_add_track	(	InteractiveHtmlBom *NONNULL	obj,
		InteractiveHtmlBomLayer	layer,
		float	start_x,
		float	start_y,
		float	end_x,
		float	end_y,
		float	width,
		const QString *	net_name
	)

Wrapper for adding a track to [InteractiveHtmlBom::tracks]

Here is the caller graph for this function:

ffi_ibom_add_via()

void ffi_ibom_add_via	(	InteractiveHtmlBom *NONNULL	obj,
		const InteractiveHtmlBomLayer *	layers_array,
		size_t	layers_size,
		float	pos_x,
		float	pos_y,
		float	diameter,
		float	drill_diameter,
		const QString *	net_name
	)

Wrapper for adding a via to [InteractiveHtmlBom::vias]

Here is the caller graph for this function:

ffi_ibom_add_zone()

void ffi_ibom_add_zone	(	InteractiveHtmlBom *NONNULL	obj,
		InteractiveHtmlBomLayer	layer,
		const QString *NONNULL	svgpath,
		const QString *	net_name
	)

Wrapper for adding a zone to [InteractiveHtmlBom::zones]

Here is the caller graph for this function:

ffi_ibom_generate_html()

bool ffi_ibom_generate_html	(	const InteractiveHtmlBom *NONNULL	obj,
		QString *NONNULL	out,
		QString *NONNULL	err
	)

Wrapper for [InteractiveHtmlBom::generate_html]

Here is the caller graph for this function:

ffi_increment_number_in_string()

void ffi_increment_number_in_string

(

QString *NONNULL

s

)

Wrapper for [increment_number_in_string]

Here is the caller graph for this function:

ffi_ziparchive_new_from_file()

ZipArchive * ffi_ziparchive_new_from_file	(	const QString *NONNULL	path,
		QString *NONNULL	err
	)

Create a new [ZipArchive] object from file path

Here is the caller graph for this function:

ffi_ziparchive_new_from_mem()

ZipArchive * ffi_ziparchive_new_from_mem	(	const QByteArray *NONNULL	data,
		QString *NONNULL	err
	)

Create a new [ZipArchive] object from memory

Here is the caller graph for this function:

ffi_ziparchive_delete()

void ffi_ziparchive_delete

(

ZipArchive *

obj

)

Delete [ZipArchive] object

Here is the caller graph for this function:

ffi_ziparchive_len()

size_t ffi_ziparchive_len

(

const ZipArchive *NONNULL

obj

)

Get number of files in [ZipArchive]

Here is the caller graph for this function:

ffi_ziparchive_name_for_index()

bool ffi_ziparchive_name_for_index	(	ZipArchive *NONNULL	obj,
		size_t	index,
		QString *NONNULL	name,
		QString *NONNULL	err
	)

Get name of a file in [ZipArchive]

Here is the caller graph for this function:

ffi_ziparchive_read_by_index()

bool ffi_ziparchive_read_by_index	(	ZipArchive *NONNULL	obj,
		size_t	index,
		QByteArray *NONNULL	buf,
		QString *NONNULL	err
	)

Read a file from [ZipArchive]

Here is the caller graph for this function:

ffi_ziparchive_extract()

bool ffi_ziparchive_extract	(	ZipArchive *NONNULL	obj,
		const QString *NONNULL	dir
	)

Extract [ZipArchive] to directory

Here is the caller graph for this function:

ffi_zipwriter_new_to_file()

ZipWriter * ffi_zipwriter_new_to_file	(	const QString *NONNULL	path,
		QString *NONNULL	err
	)

Create a new [ZipWriter] object writing to a file

Here is the caller graph for this function:

ffi_zipwriter_new_to_mem()

ZipWriter * ffi_zipwriter_new_to_mem

(

QByteArray *NONNULL

data

)

Create a new [ZipWriter] object writing to memory

Here is the caller graph for this function:

ffi_zipwriter_delete()

void ffi_zipwriter_delete

(

ZipWriter *

obj

)

Delete [ZipWriter] object

Here is the caller graph for this function:

ffi_zipwriter_write_file()

bool ffi_zipwriter_write_file	(	ZipWriter *NONNULL	obj,
		const QString *NONNULL	name,
		const QByteArray *NONNULL	data,
		uint32_t	mode,
		QString *NONNULL	err
	)

Write a file to [ZipWriter]

Here is the caller graph for this function:

ffi_zipwriter_finish()

bool ffi_zipwriter_finish	(	ZipWriter *NONNULL	obj,
		QString *NONNULL	err
	)

Finish writing to [ZipWriter]

Here is the caller graph for this function: