LV2 Toolkit  1.2.0
Public Member Functions | Static Public Member Functions | Friends | List of all members
Atom Struct Reference

#include <atom.hpp>

Public Member Functions

 Atom ()
 
 Atom (const void *atom)
 
 Atom (ForgeRef ref)
 
 Atom (AtomEvent *ev)
 
bool is_null ()
 
void * body () const
 
bool as_bool () const
 
float as_float () const
 
const AtomObject as_object () const
 
const char * as_string () const
 
int32_t as_int () const
 
int64_t as_long () const
 
uint32_t as_urid () const
 
uint32_t type () const
 
uint32_t total_size () const
 
uint32_t size () const
 
const LV2_Atom * cobj () const
 
 operator const LV2_Atom * ()
 
Atomoperator= (const Atom &other)
 
bool operator== (Atom &other)
 

Static Public Member Functions

static uint32_t pad_size (uint32_t size)
 

Friends

class AtomObject
 

Detailed Description

Basic wrapper for an LV2_Atom These are intended to be used on the stack

Constructor & Destructor Documentation

Atom ( )
inline

Create a null Atom

Atom ( const void *  atom)
inline

Create an Atom from raw data

Atom ( ForgeRef  ref)
inline

Create an Atom from a Forge Ref

Atom ( AtomEvent ev)
inline

Create an Atom from an AtomEvent

Member Function Documentation

bool as_bool ( ) const
inline

Get the body as a boolean

float as_float ( ) const
inline

Get the body as a float

int32_t as_int ( ) const
inline

Get the body as a float

int64_t as_long ( ) const
inline

Get the body as a long

const AtomObject as_object ( ) const
inline

Returns the atom casted to LV2_Atom_Object

const char* as_string ( ) const
inline

Get the body as a string

uint32_t as_urid ( ) const
inline

Get the body as a URID

void* body ( ) const
inline

Get the Atom's body

const LV2_Atom* cobj ( ) const
inline

Get the underlying LV2_Atom pointer

bool is_null ( )
inline

Determine if the Atom is null

static uint32_t pad_size ( uint32_t  size)
inlinestatic

Pad a size to 64 bits

uint32_t size ( ) const
inline

Get the Atom's body size

uint32_t total_size ( ) const
inline

Get the Atom's total size

uint32_t type ( ) const
inline

Get this Atom's type


The documentation for this struct was generated from the following file: