summaryrefslogtreecommitdiff
path: root/gsk/ngl/gskngltexturelibraryprivate.h
blob: 0ccf69a054080d171c37067bf2fb80c1a68e5da4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/* gskngltexturelibraryprivate.h
 *
 * Copyright 2020 Christian Hergert <chergert@redhat.com>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#ifndef __GSK_NGL_TEXTURE_LIBRARY_PRIVATE_H__
#define __GSK_NGL_TEXTURE_LIBRARY_PRIVATE_H__

#include "gskngltypesprivate.h"
#include "gskngltextureprivate.h"

#include "stb_rect_pack.h"

G_BEGIN_DECLS

#define GSK_TYPE_GL_TEXTURE_LIBRARY            (gsk_ngl_texture_library_get_type ())
#define GSK_NGL_TEXTURE_LIBRARY(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GSK_TYPE_GL_TEXTURE_LIBRARY, GskNglTextureLibrary))
#define GSK_IS_NGL_TEXTURE_LIBRARY(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GSK_TYPE_GL_TEXTURE_LIBRARY))
#define GSK_NGL_TEXTURE_LIBRARY_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GSK_TYPE_GL_TEXTURE_LIBRARY, GskNglTextureLibraryClass))
#define GSK_IS_NGL_TEXTURE_LIBRARY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GSK_TYPE_GL_TEXTURE_LIBRARY))
#define GSK_NGL_TEXTURE_LIBRARY_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GSK_TYPE_GL_TEXTURE_LIBRARY, GskNglTextureLibraryClass))

typedef struct _GskNglTextureAtlas
{
  struct stbrp_context context;
  struct stbrp_node *nodes;

  int width;
  int height;

  guint texture_id;

  /* Pixels of rects that have been used at some point,
   * But are now unused.
   */
  int unused_pixels;

  void *user_data;
} GskNglTextureAtlas;

typedef struct _GskNglTextureAtlasEntry
{
  /* A backreference to either the atlas or texture containing
   * the contents of the atlas entry. For larger items, no atlas
   * is used and instead a direct texture.
   */
  union {
    GskNglTextureAtlas *atlas;
    GskNglTexture *texture;
  };

  /* The area within the atlas translated to 0..1 bounds */
  struct {
    float x;
    float y;
    float x2;
    float y2;
  } area;

  /* Number of pixels in the entry, used to calculate usage
   * of an atlas while processing.
   */
  guint n_pixels : 29;

  /* If entry has marked pixels as used in the atlas this frame */
  guint used : 1;

  /* If entry was accessed this frame */
  guint accessed : 1;

  /* When true, backref is an atlas, otherwise texture */
  guint is_atlased : 1;
} GskNglTextureAtlasEntry;

typedef struct _GskNglTextureLibrary
{
  GObject        parent_instance;
  GskNglDriver *driver;
  GHashTable    *hash_table;
  guint          max_entry_size;
} GskNglTextureLibrary;

typedef struct _GskNglTextureLibraryClass
{
  GObjectClass parent_class;

  void (*begin_frame) (GskNglTextureLibrary *library,
                       gint64                frame_id,
                       GPtrArray            *removed_atlases);
} GskNglTextureLibraryClass;

G_DEFINE_AUTOPTR_CLEANUP_FUNC (GskNglTextureLibrary, g_object_unref)

GType    gsk_ngl_texture_library_get_type    (void) G_GNUC_CONST;
void     gsk_ngl_texture_library_set_funcs   (GskNglTextureLibrary *self,
                                              GHashFunc             hash_func,
                                              GEqualFunc            equal_func,
                                              GDestroyNotify        key_destroy,
                                              GDestroyNotify        value_destroy);
void     gsk_ngl_texture_library_begin_frame (GskNglTextureLibrary *self,
                                              gint64                frame_id,
                                              GPtrArray            *removed_atlases);
gpointer gsk_ngl_texture_library_pack        (GskNglTextureLibrary *self,
                                              gpointer              key,
                                              gsize                 valuelen,
                                              guint                 width,
                                              guint                 height,
                                              int                   padding,
                                              guint                *out_packed_x,
                                              guint                *out_packed_y);

static inline void
gsk_ngl_texture_atlas_mark_unused (GskNglTextureAtlas *self,
                                   int                 n_pixels)
{
  g_assert (n_pixels >= 0);

  self->unused_pixels += n_pixels;
}

static inline void
gsk_ngl_texture_atlas_entry_mark_used (GskNglTextureAtlasEntry *entry)
{
  if (entry->used == TRUE || entry->is_atlased == FALSE)
    return;

  entry->atlas->unused_pixels -= entry->n_pixels;
  entry->used = TRUE;
}

static inline void
gsk_ngl_texture_atlas_entry_mark_unused (GskNglTextureAtlasEntry *entry)
{
  if (entry->used == FALSE || entry->is_atlased == FALSE)
    return;

  entry->atlas->unused_pixels += entry->n_pixels;
  entry->used = FALSE;
}

static inline gboolean
gsk_ngl_texture_library_lookup (GskNglTextureLibrary     *self,
                                gconstpointer             key,
                                GskNglTextureAtlasEntry **out_entry)
{
  GskNglTextureAtlasEntry *entry = g_hash_table_lookup (self->hash_table, key);

  if G_LIKELY (entry != NULL && entry->accessed && entry->used)
    {
      *out_entry = entry;
      return TRUE;
    }

  if (entry != NULL)
    {
      gsk_ngl_texture_atlas_entry_mark_used (entry);
      entry->accessed = TRUE;
      *out_entry = entry;
      return TRUE;
    }

  return FALSE;
}

static inline guint
GSK_NGL_TEXTURE_ATLAS_ENTRY_TEXTURE (gconstpointer d)
{
  const GskNglTextureAtlasEntry *e = d;

  return e->is_atlased ? e->atlas->texture_id
                       : e->texture ? e->texture->texture_id : 0;
}

static inline double
gsk_ngl_texture_atlas_get_unused_ratio (const GskNglTextureAtlas *self)
{
  if (self->unused_pixels > 0)
    return (double)(self->unused_pixels) / (double)(self->width * self->height);
  return 0.0;
}

static inline gboolean
gsk_ngl_texture_library_can_cache (GskNglTextureLibrary *self,
                                   int                   width,
                                   int                   height)
{
  g_assert (self->max_entry_size > 0);
  return width <= self->max_entry_size && height <= self->max_entry_size;
}

G_END_DECLS

#endif /* __GSK_NGL_TEXTURE_LIBRARY_PRIVATE_H__ */