scm-task.hpp

// Copyright (C) 2011-2012 Robert Kooima
//
// LIBSCM is free software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the Free Software
// Foundation; either version 2 of the License, or (at your option) any later
// version.
//
// This program is distributed in the hope that it will be useful, but WITH-
// OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
// more details.

#ifndef SCM_TASK_HPP
#define SCM_TASK_HPP

#include <GL/glew.h>
#include <tiffio.h>

#include "scm-item.hpp"

//------------------------------------------------------------------------------

class scm_file;
class scm_cache;

//------------------------------------------------------------------------------

/// An scm_task represents a page load task, as executed by a loader thread
///
/// It encapsulates all of the parameters of the page to be loaded and includes
/// the OpenGL state necessary to perform an asynchronous upload of the loaded
/// data.

struct scm_task : public scm_item
{
    scm_task();
    scm_task(int, long long);
    scm_task(int, long long, uint64, int, int, int, GLuint, scm_cache *);

    void make_page(int, int);
    bool load_page(const char *, TIFF *);
    void dump_page();

    uint64     o;          ///< SCM TIFF file offset of this page
    int        n;          ///< Page size
    int        c;          ///< Page channel per pixel
    int        b;          ///< Page bits per channel
    GLuint     u;          ///< Pixel unpack buffer object
    bool       d;          ///< Pixel unpack buffer dirty flag
    void      *p;          ///< Pixel unpack buffer map address
    scm_cache *C;          ///< Destination cache
};

//------------------------------------------------------------------------------
/// @file

GLuint  scm_internal_form(uint16 c, uint16 b);
GLuint  scm_external_form(uint16 c, uint16 b);
GLuint  scm_external_type(uint16 c, uint16 b);
GLsizei scm_pixel_size   (uint16 c, uint16 b);

//------------------------------------------------------------------------------

#endif