deps/libretro-common/include/formats/image.h

   1 /* Copyright  (C) 2010-2020 The RetroArch team
   2  *
   3  * ---------------------------------------------------------------------------------------
   4  * The following license statement only applies to this file (image.h).
   5  * ---------------------------------------------------------------------------------------
   6  *
   7  * Permission is hereby granted, free of charge,
   8  * to any person obtaining a copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation the rights to
  10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
  11  * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  16  * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  */
  22
  23 #ifndef __RARCH_IMAGE_CONTEXT_H
  24 #define __RARCH_IMAGE_CONTEXT_H
  25
  26 #include <stdint.h>
  27 #include <stddef.h>
  28
  29 #include <retro_common_api.h>
  30
  31 #include <boolean.h>
  32
  33 RETRO_BEGIN_DECLS
  34
  35 enum image_process_code
  36 {
  37    IMAGE_PROCESS_ERROR     = -2,
  38    IMAGE_PROCESS_ERROR_END = -1,
  39    IMAGE_PROCESS_NEXT      =  0,
  40    IMAGE_PROCESS_END       =  1
  41 };
  42
  43 struct texture_image
  44 {
  45    uint32_t *pixels;
  46    unsigned width;
  47    unsigned height;
  48    bool supports_rgba;
  49 };
  50
  51 enum image_type_enum
  52 {
  53    IMAGE_TYPE_NONE = 0,
  54    IMAGE_TYPE_PNG,
  55    IMAGE_TYPE_JPEG,
  56    IMAGE_TYPE_BMP,
  57    IMAGE_TYPE_TGA
  58 };
  59
  60 enum image_type_enum image_texture_get_type(const char *path);
  61
  62 bool image_texture_set_color_shifts(unsigned *r_shift, unsigned *g_shift,
  63       unsigned *b_shift, unsigned *a_shift,
  64       struct texture_image *out_img);
  65
  66 bool image_texture_color_convert(unsigned r_shift,
  67       unsigned g_shift, unsigned b_shift, unsigned a_shift,
  68       struct texture_image *out_img);
  69
  70 bool image_texture_load_buffer(struct texture_image *img,
  71    enum image_type_enum type, void *buffer, size_t buffer_len);
  72
  73 bool image_texture_load(struct texture_image *img, const char *path);
  74 void image_texture_free(struct texture_image *img);
  75
  76 /* Image transfer */
  77
  78 void image_transfer_free(void *data, enum image_type_enum type);
  79
  80 void *image_transfer_new(enum image_type_enum type);
  81
  82 bool image_transfer_start(void *data, enum image_type_enum type);
  83
  84 void image_transfer_set_buffer_ptr(
  85       void *data,
  86       enum image_type_enum type,
  87       void *ptr,
  88       size_t len);
  89
  90 int image_transfer_process(
  91       void *data,
  92       enum image_type_enum type,
  93       uint32_t **buf, size_t size,
  94       unsigned *width, unsigned *height);
  95
  96 bool image_transfer_iterate(void *data, enum image_type_enum type);
  97
  98 bool image_transfer_is_valid(void *data, enum image_type_enum type);
  99
 100 RETRO_END_DECLS
 101
 102 #endif