cat_engine 0.5.0-alpha

A 2D graphics engine with audio output support
Documentation
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
use super::{TexturedVertex2D,TextObject2D};

use crate::{
    // statics
    window_center,
    // types
    Colour,
    // structs
    text::{
        TextBase,
        GlyphCache,
        OutlinedGlyph,
        Scale,
        CachedFont,
        RawGlyphCache,
    },
    graphics::TextGraphicsSettings,
};

use glium::{
    uniform,
    // enums
    DrawError,
    // traits
    Surface,
    // structs
    Program,
    Frame,
    DrawParameters,
    VertexBuffer,
    Display,
    index::{NoIndices,PrimitiveType},

    vertex::{Vertex,VertexFormat,VerticesSource},

    texture::{
        RawImage2d,
        UncompressedFloatFormat,
        MipmapsOption,
        Texture2d,
        ClientFormat,
    },
    Rect,
};

use std::borrow::Cow;

pub struct TextGraphics{
    vertex_buffer:VertexBuffer<TexturedVertex2D>,
    vertex_format:VertexFormat,

    image:Vec<u8>,
    glyph_texture:Texture2d,
    texture_size:[f32;2],

    objects:Vec<TextObject2D>,
    cached_font:Vec<CachedFont>,

    draw:Program,
    draw_shift:Program,
    draw_rotate:Program,
}

impl TextGraphics{
    pub fn new(display:&Display,settings:TextGraphicsSettings,glsl:u16)->TextGraphics{
        let (common,shift,rotation,fragment)=if glsl==120{(
            include_str!("shaders/120/texture/vertex_shader.glsl"),
            include_str!("shaders/120/texture/shift_vertex_shader.glsl"),
            include_str!("shaders/120/texture/rotation_vertex_shader.glsl"),
            include_str!("shaders/120/text/fragment_shader.glsl")
        )}
        else{(
            include_str!("shaders/texture/vertex_shader.glsl"),
            include_str!("shaders/texture/shift_vertex_shader.glsl"),
            include_str!("shaders/texture/rotation_vertex_shader.glsl"),
            include_str!("shaders/text/fragment_shader.glsl")
        )};

        let texture_size=[
            settings.glyph_texture_size[0] as f32,
            settings.glyph_texture_size[1] as f32,
        ];

        Self{
            vertex_buffer:VertexBuffer::empty_dynamic(display,4).unwrap(),
            vertex_format:TexturedVertex2D::build_bindings(),

            image:Vec::with_capacity((settings.glyph_texture_size[0]*settings.glyph_texture_size[1]) as usize),
            glyph_texture:Texture2d::empty_with_format(
                display,
                UncompressedFloatFormat::U8,
                MipmapsOption::NoMipmap,
                settings.glyph_texture_size[0],
                settings.glyph_texture_size[1],
            ).unwrap(),
            texture_size,

            objects:Vec::with_capacity(10),
            cached_font:Vec::with_capacity(10),

            draw:Program::from_source(display,common,fragment,None).unwrap(),
            draw_shift:Program::from_source(display,shift,fragment,None).unwrap(),
            draw_rotate:Program::from_source(display,rotation,fragment,None).unwrap(),
        }
    }

    /// Локальная тектстура.
    pub fn texture(&self)->&Texture2d{
        &self.glyph_texture
    }

    pub fn texture_size(&self)->[f32;2]{
        self.texture_size
    }

    /// Вписывает вершины в локальный буфер.
    pub fn write_vertices(&self,[x,y,width,height]:[f32;4],[uvw,uvh]:[f32;2]){
        let [x1,y1,x2,y2]=[
            x,
            y,
            x+width,
            y+height
        ];

        let vertices=[
            TexturedVertex2D::new([x1,y1],[0.0,uvh]),
            TexturedVertex2D::new([x1,y2],[0.0,0.0]),
            TexturedVertex2D::new([x2,y1],[uvw,uvh]),
            TexturedVertex2D::new([x2,y2],[uvw,0.0])
        ];

        self.vertex_buffer.write(&vertices);
    }

    /// Записывает глиф в локальную тектстуру.
    pub fn write_glyph(&mut self,glyph:&OutlinedGlyph){
        self.image.clear();

        // Запись изображения
        glyph.draw(|_,a|{
            let gray=255f32*a;
            let byte=gray.round() as u8;
            self.image.push(byte);
        });

        let size=glyph.size();

        let rect=Rect{
            left:0,
            bottom:0,
            width:size[0],
            height:size[1],
        };

        let raw_image=RawImage2d{
            data:Cow::Borrowed(&self.image),
            width:size[0],
            height:size[1],
            format:ClientFormat::U8,
        };

        self.glyph_texture.write(rect,raw_image);
    }

    /// Рисует глиф с загруженными вершинами.
    /// 
    /// Перед выводом нужно загрузить вершины
    /// с помощью функции `write_vertices`.
    pub fn draw_glyph(
        &self,
        glyph:&Texture2d,
        colour:Colour,
        draw_parameters:&DrawParameters,
        frame:&mut Frame
    )->Result<(),DrawError>{
        let vertices=VerticesSource::VertexBuffer(
            self.vertex_buffer.as_slice_any(),
            &self.vertex_format,
            false
        );

        let uni=uniform!{
            texture2d:glyph,
            colour:colour,
            window_center:unsafe{window_center}
        };

        frame.draw(
            vertices,
            NoIndices(PrimitiveType::TriangleStrip),
            &self.draw,
            &uni,
            draw_parameters
        )
    }



    /// Рисует глиф с загруженными вершинами.
    pub fn draw_shift_glyph(
        &self,
        glyph:&Texture2d,
        colour:Colour,
        shift:[f32;2],
        draw_parameters:&DrawParameters,
        frame:&mut Frame
    )->Result<(),DrawError>{
        let vertices=VerticesSource::VertexBuffer(
            self.vertex_buffer.as_slice_any(),
            &self.vertex_format,
            false
        );

        let uni=uniform!{
            texture2d:glyph,
            colour:colour,
            shift:shift,
            window_center:unsafe{window_center}
        };

        frame.draw(
            vertices,
            NoIndices(PrimitiveType::TriangleStrip),
            &self.draw_shift,
            &uni,
            draw_parameters
        )
    }


    /// Рисует глиф с загруженными вершинами.
    pub fn draw_rotate_glyph(
        &self,
        glyph:&Texture2d,
        colour:Colour,
        rotation_center:[f32;2],
        angle:f32,
        draw_parameters:&DrawParameters,
        frame:&mut Frame
    )->Result<(),DrawError>{
        let (sin,cos)=angle.sin_cos();

        let uni=uniform!{
            texture2d:glyph,
            colour:colour,
            cos:cos,
            sin:sin,
            rotation_center:rotation_center,
            window_center:unsafe{window_center}
        };

        frame.draw(
            &self.vertex_buffer,
            NoIndices(PrimitiveType::TriangleStrip),
            &self.draw_rotate,
            &uni,
            draw_parameters
        )
    }
}

/// Функции для работы с объектами
impl TextGraphics{
    /// Добавляет шрифт.
    pub fn push_font(
        &mut self,
        cached_font:CachedFont,
    )->Option<usize>{
        let index=self.objects.len();

        self.cached_font.push(cached_font);

        Some(index)
    }

    /// Возвращает шрифт.
    pub fn get_font(&self,index:usize)->&CachedFont{
        &self.cached_font[index]
    }

    /// Добавляет объект в конец массива.
    /// 
    /// Возвращает индекс объекта,
    /// если он добавлен.
    pub fn push_object(
        &mut self,
        text:String,
        position:[f32;2],
        scale:Scale,
        colour:Colour,
        font:usize,
    )->Option<usize>{
        let object=TextObject2D{
            text,
            position:position,
            scale,
            colour:colour,
            font,
        };

        let index=self.objects.len();

        // Если есть место в массиве,
        // добавляет объект
        if index<self.objects.capacity(){
            self.objects.push(object);
            Some(index)
        }
        else{
            None
        }
    }

    /// Удаляет последний объект.
    pub fn delete_last_object(&mut self){
        self.objects.pop();
    }

    /// Выводит сохранённый объект.
    pub fn draw_object(
        &self,
        index:usize,
        draw_parameters:&DrawParameters,
        frame:&mut Frame
    )->Result<(),DrawError>{
        let object=&self.objects[index];

        let mut position=object.position;

        let font=&self.cached_font[object.font];

        for character in object.text.chars(){
            let glyph=if let Some(glyph)=font.scaled_glyph(character,object.scale){
                glyph
            }
            else{
                if character==' '{
                    position[0]+=font.whitespace_advance_width(object.scale.horizontal);
                    continue
                }
                font.scaled_undefined_glyph(object.scale)
            };

            let rect=glyph.positioned_bounding_box(position);

            // Запись в буфер вершин
            self.write_vertices(rect,[1f32,1f32]);

            self.draw_glyph(
                glyph.data(), // текстура в данном случае
                object.colour,
                draw_parameters,
                frame
            )?;

            position[0]+=glyph.advance_width();
        }
        Ok(())
    }

    /// Выводит сдвинутый сохранённый объект.
    pub fn draw_shift_object(
        &self,
        index:usize,
        shift:[f32;2],
        draw_parameters:&DrawParameters,
        frame:&mut Frame
    )->Result<(),DrawError>{
        let object=&self.objects[index];

        let mut position=object.position;

        let font=&self.cached_font[object.font];

        for character in object.text.chars(){
            let glyph=if let Some(glyph)=font.scaled_glyph(character,object.scale){
                glyph
            }
            else{
                if character==' '{
                    position[0]+=font.whitespace_advance_width(object.scale.horizontal);
                    continue
                }
                font.scaled_undefined_glyph(object.scale)
            };

            let rect=glyph.positioned_bounding_box(position);

            // Запись в буфер вершин
            self.write_vertices(rect,[1f32,1f32]);

            self.draw_shift_glyph(
                glyph.data(), // текстура в данном случае
                object.colour,
                shift,
                draw_parameters,
                frame
            )?;

            position[0]+=glyph.advance_width();
        }

        Ok(())
    }

    /// Выводит повёрнутый сохранённый объект.
    pub fn draw_rotate_object(
        &self,
        index:usize,
        rotation_center:[f32;2],
        angle:f32,
        draw_parameters:&DrawParameters,
        frame:&mut Frame
    )->Result<(),DrawError>{
        let object=&self.objects[index];

        let mut position=object.position;

        let font=&self.cached_font[object.font];

        for character in object.text.chars(){
            let glyph=if let Some(glyph)=font.scaled_glyph(character,object.scale){
                glyph
            }
            else{
                if character==' '{
                    position[0]+=font.whitespace_advance_width(object.scale.horizontal);
                    continue
                }
                font.scaled_undefined_glyph(object.scale)
            };

            let rect=glyph.positioned_bounding_box(position);

            // Запись в буфер вершин
            self.write_vertices(rect,[1f32,1f32]);

            self.draw_rotate_glyph(
                glyph.data(), // текстура в данном случае
                object.colour,
                rotation_center,
                angle,
                draw_parameters,
                frame
            )?;

            position[0]+=glyph.advance_width();
        }

        Ok(())
    }
}