psx_gpu: move masking to set_texture
[pcsx_rearmed.git] / plugins / gpu_neon / psx_gpu / psx_gpu.h
1 /*
2  * Copyright (C) 2011 Gilead Kutnick "Exophase" <exophase@gmail.com>
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of
7  * the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  */
14
15 #ifndef PSX_GPU_H
16 #define PSX_GPU_H
17
18 typedef enum
19 {
20   PRIMITIVE_TYPE_TRIANGLE = 0,
21   PRIMITIVE_TYPE_SPRITE = 1,
22   PRIMITIVE_TYPE_LINE = 2,
23   PRIMITIVE_TYPE_UNKNOWN = 3
24 } primitive_type_enum;
25
26 typedef enum
27 {
28   TEXTURE_MODE_4BPP  = 0,
29   TEXTURE_MODE_8BPP  = 1,
30   TEXTURE_MODE_16BPP = 2
31 } texture_mode_enum;
32
33 typedef enum
34 {
35   BLEND_MODE_AVERAGE    = 0,
36   BLEND_MODE_ADD        = 1,
37   BLEND_MODE_SUBTRACT   = 2,
38   BLEND_MODE_ADD_FOURTH = 3
39 } blend_mode_enum;
40
41 typedef enum
42 {
43   RENDER_FLAGS_MODULATE_TEXELS = 0x1,
44   RENDER_FLAGS_BLEND           = 0x2,
45   RENDER_FLAGS_TEXTURE_MAP     = 0x4,
46   RENDER_FLAGS_QUAD            = 0x8,
47   RENDER_FLAGS_SHADE           = 0x10,
48 } render_flags_enum;
49
50 typedef enum
51 {
52   RENDER_STATE_DITHER          = 0x8,
53   RENDER_STATE_MASK_EVALUATE   = 0x20,
54 } render_state_enum;
55
56 typedef enum
57 {
58   RENDER_INTERLACE_ENABLED     = 0x1,
59   RENDER_INTERLACE_ODD         = 0x2,
60   RENDER_DOUBLE_MODE           = 0x4,
61 } render_mode_enum;
62
63 typedef struct
64 {
65   u16 left_x;
66   u16 num_blocks;
67   u16 right_mask;
68   u16 y;
69 } edge_data_struct;
70
71 // 64 bytes total
72 typedef struct
73 {
74   // 16 bytes
75   union
76   {
77     vec_8x16u uv;
78     vec_8x16u texels;
79     vec_8x16u draw_mask;
80   };
81
82   // 24 bytes
83   union
84   {
85     struct
86     {
87       vec_8x8u r;
88       vec_8x8u g;
89       vec_8x8u b;
90     };
91
92     vec_8x16u pixels;
93   };
94
95   // 8 bytes
96   u32 draw_mask_bits;
97   u16 *fb_ptr;
98
99   // 16 bytes
100   vec_8x16u dither_offsets;  
101 } block_struct;
102
103 #define MAX_SPANS             512
104 #define MAX_BLOCKS            64
105 #define MAX_BLOCKS_PER_ROW    128
106
107 #define SPAN_DATA_BLOCKS_SIZE 32
108
109 typedef struct render_block_handler_struct render_block_handler_struct;
110
111 typedef struct
112 {
113   // 144 bytes
114   vec_8x16u test_mask;
115
116   vec_4x32u uvrg;
117   vec_4x32u uvrg_dx;
118   vec_4x32u uvrg_dy;
119
120   vec_4x32u u_block_span;
121   vec_4x32u v_block_span;
122   vec_4x32u r_block_span;
123   vec_4x32u g_block_span;
124   vec_4x32u b_block_span;
125
126   // 76 bytes
127   u32 b;
128   u32 b_dy;
129
130   u32 triangle_area;
131
132   u32 texture_window_settings;
133   u32 current_texture_mask;
134   u32 viewport_mask;
135   u32 dirty_textures_4bpp_mask;
136   u32 dirty_textures_8bpp_mask;
137   u32 dirty_textures_8bpp_alternate_mask;
138
139   u32 triangle_color;
140   u32 dither_table[4];
141
142   struct render_block_handler_struct *render_block_handler;
143   void *texture_page_ptr;
144   void *texture_page_base;
145   u16 *clut_ptr;
146   u16 *vram_ptr;
147   u16 *vram_out_ptr;
148
149   // 26 bytes
150   u16 render_state_base;
151   u16 render_state;
152
153   u16 num_spans;
154   u16 num_blocks;
155
156   s16 offset_x;
157   s16 offset_y;
158
159   u16 clut_settings;
160   u16 texture_settings;
161
162   s16 viewport_start_x;
163   s16 viewport_start_y;
164   s16 viewport_end_x;
165   s16 viewport_end_y;
166
167   u16 mask_msb;
168
169   // 8 bytes
170   u8 triangle_winding;
171
172   u8 display_area_draw_enable;
173
174   u8 current_texture_page;
175   u8 last_8bpp_texture_page;
176
177   u8 texture_mask_width;
178   u8 texture_mask_height;
179   u8 texture_window_x;
180   u8 texture_window_y;
181
182   u8 primitive_type;
183   u8 render_mode;
184
185   // enhancement stuff
186   u16 *enhancement_buf_ptr;
187   s16 saved_viewport_start_x;
188   s16 saved_viewport_start_y;
189   s16 saved_viewport_end_x;
190   s16 saved_viewport_end_y;
191
192   // Align up to 64 byte boundary to keep the upcoming buffers cache line
193   // aligned, also make reachable with single immediate addition
194   u8 reserved_a[240];
195
196   // 8KB
197   block_struct blocks[MAX_BLOCKS_PER_ROW];
198
199   // 14336 bytes
200   vec_4x32u span_uvrg_offset[MAX_SPANS];
201   edge_data_struct span_edge_data[MAX_SPANS];
202   u32 span_b_offset[MAX_SPANS];
203
204   u8 texture_4bpp_cache[32][256 * 256];
205   u8 texture_8bpp_even_cache[16][256 * 256];
206   u8 texture_8bpp_odd_cache[16][256 * 256];
207 } psx_gpu_struct;
208
209 typedef struct __attribute__((aligned(16)))
210 {
211   u8 u;
212   u8 v;
213
214   u8 r;
215   u8 g;
216   u8 b;
217
218   u8 reserved[3];
219
220   s16 x;
221   s16 y;
222 } vertex_struct;
223
224 void render_block_fill(psx_gpu_struct *psx_gpu, u32 color, u32 x, u32 y,
225  u32 width, u32 height);
226 void render_block_copy(psx_gpu_struct *psx_gpu, u16 *source, u32 x, u32 y,
227  u32 width, u32 height, u32 pitch);
228 void render_block_move(psx_gpu_struct *psx_gpu, u32 source_x, u32 source_y,
229  u32 dest_x, u32 dest_y, u32 width, u32 height);
230
231 void render_triangle(psx_gpu_struct *psx_gpu, vertex_struct *vertexes,
232  u32 flags);
233 void render_sprite(psx_gpu_struct *psx_gpu, s32 x, s32 y, u32 u, u32 v,
234  s32 width, s32 height, u32 flags, u32 color);
235 void render_line(psx_gpu_struct *gpu, vertex_struct *vertexes, u32 flags,
236  u32 color);
237
238 u32 texture_region_mask(s32 x1, s32 y1, s32 x2, s32 y2);
239
240 void flush_render_block_buffer(psx_gpu_struct *psx_gpu);
241
242 void initialize_psx_gpu(psx_gpu_struct *psx_gpu, u16 *vram);
243 u32 gpu_parse(psx_gpu_struct *psx_gpu, u32 *list, u32 size, u32 *last_command);
244
245 void triangle_benchmark(psx_gpu_struct *psx_gpu);
246
247 #endif
248