Main Page Modules Data Structures File List Data Fields Globals

mask_tools.h File Reference

Additional private tools for dar_mask objects. More...

#include "translations.h"
#include "mask.h"

Go to the source code of this file.

Data Structures

struct dar_mask_content

Functions

DLLIMPORT int dar_mask_get_children (dar_mask *ref, dar_mask **children, int *size)

Retrieves an array of children contained in a mask union.

DLLIMPORT dar_mask_type dar_mask_get_type (dar_mask *ref)

Retrieves the type of mask contained in a dar_mask object.

DLLIMPORT void dar_mask_get_content (dar_mask_content *cont)

Retrieves pointers to a mask's content.

Detailed Description

Additional private tools for dar_mask objects.

Definition in file mask_tools.h.

Function Documentation

DLLIMPORT int dar_mask_get_children ( dar_mask * ref,

dar_mask ** children,

int * size

)

Retrieves an array of children contained in a mask union.

Parameters:

ref Pointer to mask object.

children Array of dar_mask elements.

size Number of elements returned.

Returns:
Number of elements returned.

DLLIMPORT void dar_mask_get_content ( dar_mask_content * cont )

Retrieves pointers to a mask's content.
The content stored in the container structure is dependant on the type of mask node. dar_mask_get_type should be called before calling this function.
All returned pointers map to statically allocated memory or memory controlled by the mask object. Pointers must not by freed by the caller and may be invalid once the mask object is freed.
Parameters:

cont Content container with values and pointers to mask object contents.

DLLIMPORT dar_mask_type dar_mask_get_type ( dar_mask * ref )

Retrieves the type of mask contained in a dar_mask object.

Parameters:

ref Pointer to mask object.

Returns:
Type of mask object.


Data Structures
struct	dar_mask_content
Functions
DLLIMPORT int	dar_mask_get_children (dar_mask ref, dar_mask children, int size)
	Retrieves an array of children contained in a mask union.
DLLIMPORT dar_mask_type	dar_mask_get_type (dar_mask *ref)
	Retrieves the type of mask contained in a `dar_mask` object.
DLLIMPORT void	dar_mask_get_content (dar_mask_content *cont)
	Retrieves pointers to a mask's content.