LayOut C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions
layerlist.h File Reference
#include <LayOutAPI/common.h>
#include <LayOutAPI/model/defs.h>

Go to the source code of this file.

Functions

LO_RESULT LOLayerListCreate (LOLayerListRef *layer_list)
 Creates a new empty layer list object. More...
 
LO_RESULT LOLayerListRelease (LOLayerListRef *layer_list)
 Releases a layer list object. *layer_list will be set to invalid by this function. More...
 
LO_RESULT LOLayerListGetNumberOfLayers (LOLayerListRef layer_list, size_t *num_layers)
 Gets the number of layer definitions in the list. More...
 
LO_RESULT LOLayerListGetLayerAtIndex (LOLayerListRef layer_list, size_t index, LOLayerRef *layer)
 Gets the layer definition at the specified index. More...
 

Function Documentation

LO_RESULT LOLayerListCreate ( LOLayerListRef layer_list)

Creates a new empty layer list object.

Parameters
[out]layer_listThe layer definition list object.
Returns
LO_RESULT LOLayerListGetLayerAtIndex ( LOLayerListRef  layer_list,
size_t  index,
LOLayerRef layer 
)

Gets the layer definition at the specified index.

Parameters
[in]layer_listThe layer definition list object.
[in]indexThe index of the layer definition object to get.
[out]layerThe layer definition object.
Returns
LO_RESULT LOLayerListGetNumberOfLayers ( LOLayerListRef  layer_list,
size_t *  num_layers 
)

Gets the number of layer definitions in the list.

Parameters
[in]layer_listThe layer definition list object.
[out]num_layersThe number of layer definitions in the list.
Returns
LO_RESULT LOLayerListRelease ( LOLayerListRef layer_list)

Releases a layer list object. *layer_list will be set to invalid by this function.

Parameters
[in]layer_listThe layer definition list object.
Returns