src/ascension/text.h

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * Copyright 2023 Mike Becker. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ASCENSION_TEXT_H
#define ASCENSION_TEXT_H

#include "font.h"
#include "scene.h"

typedef struct AscText {
    extend_asc_scene_node;
    char *text;
    AscFont const *font;
    asc_col4i color;
    unsigned max_width;
    bool hidden;
    bool centered;
    unsigned tex_id;
} AscText;


/**
 * Creates a text node.
 *
 * The current context ink and font will be used.
 *
 * @param x the position where to draw the text
 * @param y the position where to draw the text
 * @param text the text to draw
 * @return the scene node
 *
 * @see asc_ink()
 * @see asc_font()
 */
AscSceneNode *asc_text(int x, int y, char const* text);

/**
 * Provides access to the text data fields.
 *
 * @param node scene node created by asc_text()
 */
#define asc_text_data(node) ((AscText*)node)

/**
 * Releases all the memory of this node.
 *
 * @param node the text node
 */
void asc_text_free(AscText *node);

#endif //ASCENSION_TEXT_H