libx52util.h

Go to the documentation of this file.

/*
 * Saitek X52 Pro Utility Library
 *
 * Copyright (C) 2015 Nirenjan Krishnan (nirenjan@nirenjan.org)
 *
 * SPDX-License-Identifier: GPL-2.0-only WITH Classpath-exception-2.0
 */
 
#ifndef LIBX52UTIL_H
#define LIBX52UTIL_H
 
#include <stddef.h>
#include <stdint.h>
 
#ifndef LIBX52UTIL_API
# if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 303
#  define LIBX52UTIL_API __attribute__((visibility("default")))
# elif defined(_WIN32)
#  define LIBX52UTIL_API __declspec(dllexport)
# else
#  define LIBX52UTIL_API
# endif
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
LIBX52UTIL_API int libx52util_convert_utf8_string(const uint8_t *input,
                                                  uint8_t *output, size_t *len);
 
typedef struct libx52util_scroll libx52util_scroll_state;
 
typedef enum libx52util_scroll_flags {
    LIBX52UTIL_SCROLL_NONE = 0,
    LIBX52UTIL_SCROLL_IN = 1u << 0,
    LIBX52UTIL_SCROLL_OUT = 1u << 1,
    LIBX52UTIL_SCROLL_LTR = 1u << 2,
    LIBX52UTIL_SCROLL_SINGLE_PASS = 1u << 3,
} libx52util_scroll_flags;
 
LIBX52UTIL_API int libx52util_scroll_new(libx52util_scroll_state **state,
                                         const uint8_t *utf8_string,
                                         libx52util_scroll_flags flags);
 
LIBX52UTIL_API void libx52util_scroll_free(libx52util_scroll_state **state);
 
LIBX52UTIL_API int libx52util_scroll_reset(libx52util_scroll_state *state);
 
LIBX52UTIL_API int libx52util_scroll_next(libx52util_scroll_state *state,
                                           uint8_t display[16]);
 
#ifdef __cplusplus
}
#endif
 
#endif /* !defined LIBX52UTIL_H */