libsdfio/layout_8h_source.html

/*

 * SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>

 *

 * SPDX-License-Identifier: MIT

 */


#ifndef SDFIO_LAYOUT_H

#define SDFIO_LAYOUT_H


#include <sdfio/sdfio_export.h>

#include <sdfio/types.h>


#include <stddef.h>


#ifdef __cplusplus

extern "C"

{

#endif


typedef struct sdfio_layout

{

    sdfio_data_type type;

    ptrdiff_t element_stride;

    ptrdiff_t row_stride;

} sdfio_layout;


SDFIO_API void sdfio_layout_init(sdfio_layout *layout);


SDFIO_API const sdfio_layout *sdfio_layout_packed(sdfio_data_type type);


#ifdef __cplusplus

}

#endif


#endif /* SDFIO_LAYOUT_H */

sdfio_layout_packed
const sdfio_layout * sdfio_layout_packed(sdfio_data_type type)
Returns the layout of a plain array: the elements follow each other and the rows follow each other.

sdfio_layout_init
void sdfio_layout_init(sdfio_layout *layout)
Initializes a layout of a plain array of float elements: the elements follow each other and the rows ...

sdfio_layout
Description of a buffer of the caller for heights or for the values of the data area: the type of its...
Definition layout.h:45

sdfio_layout::element_stride
ptrdiff_t element_stride
Distance in bytes between consecutive elements within a row.
Definition layout.h:54

sdfio_layout::row_stride
ptrdiff_t row_stride
Distance in bytes between consecutive rows.
Definition layout.h:62

sdfio_layout::type
sdfio_data_type type
Type of the elements of the buffer.
Definition layout.h:49

types.h
Status codes, enumerations, constants, and the structures for allocator, stream and time zone.

sdfio_data_type
sdfio_data_type
Type of the coded values of the data area of a file, and of the elements of a buffer of heights.
Definition types.h:112