org.lwjgl.stb.STBIReadCallbackI Maven / Gradle / Ivy

/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.stb;

import org.lwjgl.system.*;

import static org.lwjgl.system.dyncall.DynCallback.*;

/**
 * Instances of this interface may be set to the {@code read} field of the {@link STBIIOCallbacks} struct.
 * 
 * Type
 * 
 * 
 * int (*) (
 *     void *user,
 *     char *data,
 *     int size
 * )
 */
@FunctionalInterface
@NativeType("int (*) (void *, char *, int)")
public interface STBIReadCallbackI extends CallbackI.I {

    String SIGNATURE = "(ppi)i";

    @Override
    default String getSignature() { return SIGNATURE; }

    @Override
    default int callback(long args) {
        return invoke(
            dcbArgPointer(args),
            dcbArgPointer(args),
            dcbArgInt(args)
        );
    }

    /**
     * The {@code stbi_io_callbacks.read} callback.
     *
     * @param user a pointer to user data
     * @param data the data buffer to fill
     * @param size the number of bytes to read
     *
     * @return the number of bytes actually read
     */
    int invoke(@NativeType("void *") long user, @NativeType("char *") long data, int size);

}