BRL-CAD
Loading...
Searching...
No Matches
dm.h
Go to the documentation of this file.
1/* D M . H
2 * BRL-CAD
3 *
4 * Copyright (c) 1993-2025 United States Government as represented by
5 * the U.S. Army Research Laboratory.
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public License
9 * version 2.1 as published by the Free Software Foundation.
10 *
11 * This library is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this file; see the file named COPYING for more
18 * information.
19 */
20/** @addtogroup libdm */
21/** @{ */
22/** @file dm.h
23 *
24 */
25
26#ifndef DM_H
27#define DM_H
28
29#include "common.h"
30
31#include "vmath.h"
32#include "bu/vls.h"
33#include "bn.h"
34#include "bv.h"
35#include "icv.h"
36
37#include "./dm/defines.h"
38#include "./dm/fbserv.h"
39#include "./dm/util.h"
40#include "./dm/view.h"
41
43
44#define DM_NULL (struct dm *)NULL
45
46/* the font used depends on the size of the window opened */
47#define FONTBACK "-adobe-courier-medium-r-normal--10-100-75-75-m-60-iso8859-1"
48#define FONT5 "5x7"
49#define FONT6 "6x10"
50#define FONT7 "7x13"
51#define FONT8 "8x13"
52#define FONT9 "9x15"
53#define FONT10 "10x20"
54#define FONT12 "12x24"
55
56#if defined(_WIN32) && !defined(__CYGWIN__)
57# define DM_VALID_FONT_SIZE(_size) (14 <= (_size) && (_size) <= 29)
58#else
59# define DM_VALID_FONT_SIZE(_size) (5 <= (_size) && (_size) <= 12 && (_size) != 11)
60# define DM_FONT_SIZE_TO_NAME(_size) (((_size) == 5) ? FONT5 : (((_size) == 6) ? FONT6 : (((_size) == 7) ? FONT7 : (((_size) == 8) ? FONT8 : (((_size) == 9) ? FONT9 : (((_size) == 10) ? FONT10 : FONT12))))))
61#endif
62
63/* This is how a parent application can pass a generic
64 * hook function in when setting dm variables. The dm_hook_data
65 * container holds the bu_structparse hook function and data
66 * needed by it in the dm_hook and dm_hook_data slots. When
67 * bu_struct_parse or one of the other libbu structure parsing
68 * functions is called, the dm_hook_data container is passed
69 * in as the data slot in that call.
70 *
71 * TODO - need example
72 *
73 */
74struct dm_hook_data {
75 void(*dm_hook)(const struct bu_structparse *, const char *, void *, const char *, void *);
76 void *dmh_data;
77};
78
79DM_EXPORT extern struct dm dm_null;
80
81DM_EXPORT extern void *dm_interp(struct dm *dmp);
82DM_EXPORT extern void *dm_get_ctx(struct dm *dmp);
83DM_EXPORT extern void *dm_get_udata(struct dm *dmp);
84DM_EXPORT extern void dm_set_udata(struct dm *dmp, void *udata);
85DM_EXPORT extern int dm_share_dlist(struct dm *dmp1,
86 struct dm *dmp2);
87DM_EXPORT extern fastf_t dm_Xx2Normal(struct dm *dmp,
88 int x);
89DM_EXPORT extern int dm_Normal2Xx(struct dm *dmp,
91DM_EXPORT extern fastf_t dm_Xy2Normal(struct dm *dmp,
92 int y,
93 int use_aspect);
94DM_EXPORT extern int dm_Normal2Xy(struct dm *dmp,
96 int use_aspect);
97DM_EXPORT extern void dm_fogHint(struct dm *dmp,
98 int fastfog);
99DM_EXPORT extern int dm_processOptions(struct dm *dmp, struct bu_vls *init_proc_vls, int argc, const char **argv);
101/* adc.c */
102DM_EXPORT extern void dm_draw_adc(struct dm *dmp,
104
105/* axes.c */
106DM_EXPORT extern void dm_draw_data_axes(struct dm *dmp,
108 struct bv_data_axes_state *bndasp);
109
110DM_EXPORT extern void dm_draw_scene_axes(struct dm *dmp, struct bv_scene_obj *s);
112
113DM_EXPORT extern void dm_draw_hud_axes(struct dm *dmp,
115 const mat_t rmat,
116 struct bv_axes *bnasp);
117
118/* clip.c */
119DM_EXPORT extern int clip(fastf_t *,
121 fastf_t *,
122 fastf_t *);
123DM_EXPORT extern int vclip(point_t,
125 fastf_t *,
126 fastf_t *);
127
128/* grid.c */
129DM_EXPORT extern void dm_draw_grid(struct dm *dmp,
133 fastf_t base2local);
134
135/* labels.c */
136#ifdef DM_WITH_RT
137#include "raytrace.h"
138DM_EXPORT extern int dm_draw_prim_labels(struct dm *dmp,
139 struct rt_wdb *wdbp,
140 const char *name,
142 int *labelsColor,
143 int (*labelsHook)(struct dm *dmp_arg, struct rt_wdb *wdbp_arg,
144 const char *name_arg, mat_t viewmat_arg,
147#endif
148
149/* rect.c */
150DM_EXPORT extern void dm_draw_rect(struct dm *dmp,
152
153/* scale.c */
154DM_EXPORT extern void dm_draw_scale(struct dm *dmp,
156 const char *unit,
157 int *lineColor,
158 int *textColor);
159
160/* vers.c */
161DM_EXPORT extern const char *dm_version(void);
163
164/* Plugin related functions */
165DM_EXPORT extern int dm_valid_type(const char *name, const char *dpy_string);
166DM_EXPORT const char * dm_init_msgs(void);
167DM_EXPORT extern struct dm *dm_open(void *ctx,
168 void *interp,
169 const char *type,
170 int argc,
171 const char *argv[]);
172DM_EXPORT extern void dm_list_types(struct bu_vls *list, const char *separator);
173DM_EXPORT const char *dm_bestXType(const char *dpy_string);
176/* This reports the graphics system associated with the specified dm type (returned values
177 * right now would be NULL, Tk or Qt - another eventual possibility is GLFW...) */
178DM_EXPORT extern const char *dm_graphics_system(const char *dmtype);
180/* functions to make a dm struct hideable - will need to
181 * sort these out later */
182
183DM_EXPORT extern const char *dm_get_dm_name(const struct dm *dmp);
184DM_EXPORT extern const char *dm_get_dm_lname(struct dm *dmp);
185DM_EXPORT extern const char *dm_get_graphics_system(const struct dm *dmp);
186DM_EXPORT extern int dm_get_width(struct dm *dmp);
187DM_EXPORT extern int dm_get_height(struct dm *dmp);
188DM_EXPORT extern void dm_set_width(struct dm *dmp, int width);
189DM_EXPORT extern void dm_set_height(struct dm *dmp, int height);
190DM_EXPORT extern void dm_geometry_request(struct dm *dmp, int width, int height);
191DM_EXPORT extern void dm_internal_var(struct bu_vls *result, struct dm *dmp, const char *key); // ick
192DM_EXPORT extern fastf_t dm_get_aspect(struct dm *dmp);
193DM_EXPORT extern int dm_graphical(const struct dm *dmp);
194DM_EXPORT extern const char *dm_get_type(struct dm *dmp);
195DM_EXPORT extern unsigned long dm_get_id(struct dm *dmp);
196DM_EXPORT extern void dm_set_id(struct dm *dmp, unsigned long new_id);
197DM_EXPORT extern int dm_get_displaylist(struct dm *dmp);
198DM_EXPORT extern int dm_close(struct dm *dmp);
199DM_EXPORT extern int dm_get_bg(unsigned char **bg1, unsigned char **bg2, struct dm *dmp);
200DM_EXPORT extern int dm_set_bg(struct dm *dmp, unsigned char r1, unsigned char g1, unsigned char b1, unsigned char r2, unsigned char g2, unsigned char b2);
201DM_EXPORT extern unsigned char *dm_get_fg(struct dm *dmp);
202DM_EXPORT extern int dm_set_fg(struct dm *dmp, unsigned char r, unsigned char g, unsigned char b, int strict, fastf_t transparency);
203DM_EXPORT extern int dm_reshape(struct dm *dmp, int width, int height);
204DM_EXPORT extern int dm_make_current(struct dm *dmp);
205DM_EXPORT extern int dm_doevent(struct dm *dmp, void *clientData, void *eventPtr);
206DM_EXPORT extern int dm_get_dirty(struct dm *dmp);
207DM_EXPORT extern void dm_set_dirty(struct dm *dmp, int i);
208DM_EXPORT extern vect_t *dm_get_clipmin(struct dm *dmp);
209DM_EXPORT extern vect_t *dm_get_clipmax(struct dm *dmp);
210DM_EXPORT extern int dm_get_stereo(struct dm *dmp);
211DM_EXPORT extern int dm_set_win_bounds(struct dm *dmp, fastf_t *w);
212DM_EXPORT extern int dm_configure_win(struct dm *dmp, int force);
213DM_EXPORT extern struct bu_vls *dm_get_pathname(struct dm *dmp);
214DM_EXPORT extern void dm_set_pathname(struct dm *dmp, const char *pname);
215DM_EXPORT extern struct bu_vls *dm_get_dname(struct dm *dmp);
216DM_EXPORT extern const char *dm_get_name(const struct dm *dmp);
217DM_EXPORT extern struct bu_vls *dm_get_tkname(struct dm *dmp);
218DM_EXPORT extern int dm_get_fontsize(struct dm *dmp);
219DM_EXPORT extern void dm_set_fontsize(struct dm *dmp, int size);
221DM_EXPORT extern int dm_get_linewidth(struct dm *dmp);
222DM_EXPORT extern void dm_set_linewidth(struct dm *dmp, int linewidth);
223DM_EXPORT extern int dm_get_linestyle(struct dm *dmp);
224DM_EXPORT extern void dm_set_linestyle(struct dm *dmp, int linestyle);
225DM_EXPORT extern int dm_get_perspective(struct dm *dmp);
227DM_EXPORT extern int dm_get_display_image(struct dm *dmp, unsigned char **image, int flip, int alpha);
228DM_EXPORT extern int dm_draw_vlist(struct dm *dmp, struct bv_vlist *vp);
229DM_EXPORT extern int dm_draw_vlist_hidden_line(struct dm *dmp, struct bv_vlist *vp);
230DM_EXPORT extern int dm_set_line_attr(struct dm *dmp, int width, int style);
231DM_EXPORT extern int dm_draw_begin(struct dm *dmp);
232DM_EXPORT extern int dm_draw_end(struct dm *dmp);
233DM_EXPORT extern int dm_hud_begin(struct dm *dmp);
234DM_EXPORT extern int dm_hud_end(struct dm *dmp);
235DM_EXPORT extern int dm_loadmatrix(struct dm *dmp, fastf_t *mat, int eye);
236DM_EXPORT extern int dm_loadpmatrix(struct dm *dmp, const fastf_t *mat);
237DM_EXPORT extern void dm_pop_pmatrix(struct dm *dmp);
238DM_EXPORT extern int dm_draw_string_2d(struct dm *dmp, const char *str, fastf_t x, fastf_t y, int size, int use_aspect);
239DM_EXPORT extern int dm_string_bbox_2d(struct dm *dmp, vect2d_t *bmin, vect2d_t *bmax, const char *str, fastf_t x, fastf_t y, int size, int use_aspect);
242DM_EXPORT extern int dm_draw_lines_3d(struct dm *dmp, int npoints, point_t *points, int sflag);
243DM_EXPORT extern int dm_draw_point_2d(struct dm *dmp, fastf_t x, fastf_t y);
244DM_EXPORT extern int dm_draw_point_3d(struct dm *dmp, point_t pt);
245DM_EXPORT extern int dm_draw_points_3d(struct dm *dmp, int npoints, point_t *points);
246DM_EXPORT extern int dm_draw(struct dm *dmp, struct bv_vlist *(*callback)(void *), void **data);
247DM_EXPORT extern int dm_set_depth_mask(struct dm *dmp, int d_on);
248DM_EXPORT extern int dm_set_debug(struct dm *dmp, int lvl);
249DM_EXPORT extern int dm_get_debug(struct dm *dmp);
250DM_EXPORT extern int dm_logfile(struct dm *dmp, const char *filename);
251DM_EXPORT extern struct fb *dm_get_fb(struct dm *dmp);
252DM_EXPORT extern int dm_get_fb_visible(struct dm *dmp);
253DM_EXPORT extern int dm_set_fb_visible(struct dm *dmp, int is_fb_visible);
255
256/* Variables modifiable by dm get/set commands, as well as C functions */
257DM_EXPORT extern int dm_get_light(struct dm *dmp);
258DM_EXPORT extern int dm_set_light(struct dm *dmp, int light);
259DM_EXPORT extern int dm_get_transparency(struct dm *dmp);
260DM_EXPORT extern int dm_set_transparency(struct dm *dmp, int transparency);
261DM_EXPORT extern int dm_get_zbuffer(struct dm *dmp);
262DM_EXPORT extern int dm_set_zbuffer(struct dm *dmp, int zbuffer);
263DM_EXPORT extern int dm_get_zclip(struct dm *dmp);
264DM_EXPORT extern void dm_set_zclip(struct dm *dmp, int zclip);
265DM_EXPORT extern fastf_t dm_get_bound(struct dm *dmp);
266DM_EXPORT extern void dm_set_bound(struct dm *dmp, fastf_t val);
267DM_EXPORT extern int dm_get_bound_flag(struct dm *dmp);
268DM_EXPORT extern void dm_set_bound_flag(struct dm *dmp, int bound);
270
271
272DM_EXPORT extern int dm_draw_obj(struct dm *dmp, struct bv_scene_obj *s);
274
275/* Rather low level exposure of display list concepts. Needed for MGED
276 * and libtclcad, but we want to get to a point where the use (or not)
277 * of display lists is an implementation level action rather than something
278 * visible to the user. */
279DM_EXPORT extern int dm_gen_dlists(struct dm *dmp, size_t range);
280DM_EXPORT extern int dm_begin_dlist(struct dm *dmp, unsigned int list);
281DM_EXPORT extern int dm_draw_dlist(struct dm *dmp, unsigned int list);
282DM_EXPORT extern int dm_end_dlist(struct dm *dmp);
283DM_EXPORT extern int dm_free_dlists(struct dm *dmp, unsigned int list, int range);
284DM_EXPORT extern int dm_draw_display_list(struct dm *dmp, struct display_list *obj);
285DM_EXPORT extern int dm_draw_head_dl(struct dm *dmp,
286 struct bu_list *dl,
289 short r, short g, short b,
290 int line_width,
291 int draw_style,
292 int draw_edit,
293 unsigned char *gdc,
294 int solids_down,
295 int mv_dlist
296 );
297
298// TODO - this should be using libicv - right now this is just moving the guts
299// of dmo_png_cmd behind the call table, so only provides PNG...
300DM_EXPORT extern int dm_write_image(struct bu_vls *msgs, FILE *fp, struct dm *dmp);
301
302DM_EXPORT extern void dm_flush(struct dm *dmp);
303DM_EXPORT extern void dm_sync(struct dm *dmp);
305// Return 1 if same, 0 if different and -1 if no dmp available
306typedef enum {
313/* TODO - dm_vp is supposed to go away, but until we figure it out
314 * expose it here to allow dm hiding */
315DM_EXPORT extern void dm_set_vp(struct dm *dmp, fastf_t *vp);
316
317DM_EXPORT extern int dm_set_hook(const struct bu_structparse_map *map,
318 const char *key, void *data, struct dm_hook_data *hook);
319
320DM_EXPORT extern struct bu_structparse *dm_get_vparse(struct dm *dmp);
321DM_EXPORT extern void *dm_get_mvars(struct dm *dmp);
322
323DM_EXPORT extern const char *dm_default_type(void);
325/*
326 * Needed for fd_set, avoid including sys/select.h outright since it
327 * conflicts on some systems (e.g. freebsd4).
328 *
329 * FIXME: would be nice to decouple this interface from fd_set as it's
330 * only used in one place right now.
331 */
332#if defined(HAVE_SYS_TYPES_H)
333# include <sys/types.h>
334#endif
335#if defined(HAVE_SYS_TIME_H)
336# include <sys/time.h>
337#endif
338#include <stdio.h> /* for FILE */
339
340#include "bsocket.h"
341
342#include "pkg.h"
343#include "bu/magic.h"
344#include "bu/vls.h"
345
346/**
347 * Format of disk pixels is .pix raw image files. Formerly used as
348 * arguments to many of the library routines, but has fallen into
349 * disuse due to the difficulties with ANSI function prototypes, and
350 * the fact that arrays are not real types in C. The most notable
351 * problem is that of passing a pointer to an array of RGBpixel. It
352 * looks doubly dimensioned, but isn't.
353 */
354typedef unsigned char RGBpixel[3];
355
356
357/**
358 * These generic color maps have up to 16 bits of significance,
359 * left-justified in a short. Think of this as fixed-point values
360 * from 0 to 1.
361 */
362typedef struct {
363 unsigned short cm_red[256];
364 unsigned short cm_green[256];
365 unsigned short cm_blue[256];
369#define PIXEL_NULL (unsigned char *) 0
370#define RGBPIXEL_NULL (unsigned char *) 0
371#define COLORMAP_NULL (ColorMap *) 0
372
373#define FB_NULL (struct fb *) 0
375/**
376 * assert the integrity of a framebuffer struct.
377 */
378#define FB_CK_FB(_p) BU_CKMAG(_p, FB_MAGIC, "FB")
379
380/* Library entry points */
381
382DM_EXPORT struct fb *fb_get(void);
383DM_EXPORT struct fb *fb_raw(const char *type);
384DM_EXPORT void fb_put(struct fb *ifp);
385DM_EXPORT struct dm *fb_get_dm(struct fb *ifp);
386DM_EXPORT extern const char *fb_gettype(struct fb *ifp);
387DM_EXPORT extern void fb_set_standalone(struct fb *ifp, int val);
388DM_EXPORT extern int fb_get_standalone(struct fb *ifp);
389DM_EXPORT extern int fb_get_max_width(struct fb *ifp);
390DM_EXPORT extern int fb_get_max_height(struct fb *ifp);
391DM_EXPORT extern int fb_getwidth(struct fb *ifp);
392DM_EXPORT extern int fb_getheight(struct fb *ifp);
393DM_EXPORT extern int fb_poll(struct fb *ifp);
394/* Returns in microseconds the maximum recommended amount of time to linger
395 * before polling for updates for a specific framebuffer instance (can be
396 * implementation dependent.) Zero means the fb_poll process does nothing
397 * (for example, the NULL fb). */
398DM_EXPORT extern long fb_poll_rate(struct fb *ifp);
399DM_EXPORT extern int fb_help(struct fb *ifp);
400DM_EXPORT extern int fb_free(struct fb *ifp);
401DM_EXPORT extern int fb_clear(struct fb *ifp, unsigned char *pp);
402DM_EXPORT extern ssize_t fb_read(struct fb *ifp, int x, int y, unsigned char *pp, size_t count);
403DM_EXPORT extern ssize_t fb_write(struct fb *ifp, int x, int y, const unsigned char *pp, size_t count);
404DM_EXPORT extern int fb_rmap(struct fb *ifp, ColorMap *cmap);
405DM_EXPORT extern int fb_wmap(struct fb *ifp, const ColorMap *cmap);
406DM_EXPORT extern int fb_view(struct fb *ifp, int xcenter, int ycenter, int xzoom, int yzoom);
407DM_EXPORT extern int fb_getview(struct fb *ifp, int *xcenter, int *ycenter, int *xzoom, int *yzoom);
408DM_EXPORT extern int fb_setcursor(struct fb *ifp, const unsigned char *bits, int xb, int yb, int xo, int yo);
409DM_EXPORT extern int fb_cursor(struct fb *ifp, int mode, int x, int y);
410DM_EXPORT extern int fb_getcursor(struct fb *ifp, int *mode, int *x, int *y);
411DM_EXPORT extern int fb_readrect(struct fb *ifp, int xmin, int ymin, int width, int height, unsigned char *pp);
412DM_EXPORT extern int fb_writerect(struct fb *ifp, int xmin, int ymin, int width, int height, const unsigned char *pp);
413DM_EXPORT extern int fb_bwreadrect(struct fb *ifp, int xmin, int ymin, int width, int height, unsigned char *pp);
414DM_EXPORT extern int fb_bwwriterect(struct fb *ifp, int xmin, int ymin, int width, int height, const unsigned char *pp);
416DM_EXPORT extern struct fb *fb_open(const char *file, int _width, int _height);
417DM_EXPORT extern int fb_close(struct fb *ifp);
418DM_EXPORT extern int fb_close_existing(struct fb *ifp);
419DM_EXPORT extern int fb_genhelp(void);
420DM_EXPORT extern int fb_ioinit(struct fb *ifp);
421DM_EXPORT extern int fb_seek(struct fb *ifp, int x, int y);
422DM_EXPORT extern int fb_tell(struct fb *ifp, int *xp, int *yp);
423DM_EXPORT extern int fb_rpixel(struct fb *ifp, unsigned char *pp);
424DM_EXPORT extern int fb_wpixel(struct fb *ifp, unsigned char *pp);
425DM_EXPORT extern int fb_flush(struct fb *ifp);
426DM_EXPORT extern int fb_configure_window(struct fb *, int, int);
427DM_EXPORT extern int fb_refresh(struct fb *ifp, int x, int y, int w, int h);
428#if !defined(_WIN32) || defined(__CYGWIN__)
429DM_EXPORT extern void fb_log(const char *fmt, ...) _BU_ATTR_PRINTF12;
430#endif
431DM_EXPORT extern int fb_null(struct fb *ifp);
432DM_EXPORT extern int fb_null_setcursor(struct fb *ifp, const unsigned char *bits, int xbits, int ybits, int xorig, int yorig);
434/* utility functions */
435DM_EXPORT extern int fb_common_file_size(size_t *widthp, size_t *heightp, const char *filename, int pixel_size);
436DM_EXPORT extern int fb_common_image_size(size_t *widthp, size_t *heightp, size_t npixels);
437DM_EXPORT extern int fb_common_name_size(size_t *widthp, size_t *heightp, const char *name);
438DM_EXPORT extern int fb_write_fp(struct fb *ifp, FILE *fp, int req_width, int req_height, int crunch, int inverse, struct bu_vls *result);
439DM_EXPORT extern int fb_read_fd(struct fb *ifp, int fd, int file_width, int file_height, int file_xoff, int file_yoff, int scr_width, int scr_height, int scr_xoff, int scr_yoff, int fileinput, char *file_name, int one_line_only, int multiple_lines, int autosize, int inverse, int clear, int zoom, struct bu_vls *result);
440DM_EXPORT extern int fb_read_icv(struct fb *ifp, icv_image_t *img, int file_xoff, int file_yoff, int file_maxwidth, int file_maxheight, int scr_xoff, int scr_yoff, int clear, int zoom, int inverse, int one_line_only, int multiple_lines, struct bu_vls *result);
441DM_EXPORT extern icv_image_t *fb_write_icv(struct fb *ifp, int scr_xoff, int scr_yoff, int width, int height);
442DM_EXPORT extern int fb_read_png(struct fb *ifp, FILE *fp_in, int file_xoff, int file_yoff, int scr_xoff, int scr_yoff, int clear, int zoom, int inverse, int one_line_only, int multiple_lines, int verbose, int header_only, double def_screen_gamma, struct bu_vls *result);
444DM_EXPORT extern int fb_set_interface(struct fb *ifp, const char *interface_type);
445DM_EXPORT extern const char *fb_get_name(const struct fb *ifp);
446DM_EXPORT extern void fb_set_magic(struct fb *ifp, uint32_t magic);
447DM_EXPORT extern long fb_get_pagebuffer_pixel_size(struct fb *ifp);
449DM_EXPORT extern int fb_is_set_fd(struct fb *ifp, fd_set *infds);
452
453/* color mapping */
456
457/* open_existing functionality. */
461DM_EXPORT extern struct fb *fb_open_existing(const char *file, int _width, int _height, struct fb_platform_specific *fb_p);
462DM_EXPORT extern void fb_setup_existing(struct fb *fbp, int _width, int _height, struct fb_platform_specific *fb_p);
464/* backward compatibility hacks */
465DM_EXPORT extern int fb_reset(struct fb *ifp);
466DM_EXPORT extern int fb_viewport(struct fb *ifp, int left, int top, int right, int bottom);
467DM_EXPORT extern int fb_window(struct fb *ifp, int xcenter, int ycenter);
468DM_EXPORT extern int fb_zoom(struct fb *ifp, int xzoom, int yzoom);
469DM_EXPORT extern int fb_scursor(struct fb *ifp, int mode, int x, int y);
472 * Copy one RGB pixel to another.
473 */
474#define COPYRGB(to, from) { (to)[RED]=(from)[RED];\
475 (to)[GRN]=(from)[GRN];\
476 (to)[BLU]=(from)[BLU]; }
477
478/* Debug Bitvector Definition */
479#define FB_DEBUG_BIO 1 /* Buffered io calls (less r/wpixel) */
480#define FB_DEBUG_CMAP 2 /* Contents of colormaps */
481#define FB_DEBUG_RW 4 /* Contents of reads and writes */
482#define FB_DEBUG_BRW 8 /* Buffered IO rpixel and wpixel */
484/**
485 * report version information about LIBFB
486 */
487DM_EXPORT extern const char *fb_version(void);
488
489
490/* To avoid breaking things too badly, temporarily expose
491 * what is now internal API */
492#ifdef EXPOSE_FB_HEADER
493# include "../src/libfb/fb_private.h"
494#endif
495
496typedef struct fb_internal FBIO;
497
498
499/*
500 * Types of packages used for the remote frame buffer
501 * communication
502 */
503#define MSG_FBOPEN 1
504#define MSG_FBCLOSE 2
505#define MSG_FBCLEAR 3
506#define MSG_FBREAD 4
507#define MSG_FBWRITE 5
508#define MSG_FBCURSOR 6 /**< @brief fb_cursor(void) */
509#define MSG_FBWINDOW 7 /**< @brief OLD */
510#define MSG_FBZOOM 8 /**< @brief OLD */
511#define MSG_FBSCURSOR 9 /**< @brief OLD */
512#define MSG_FBVIEW 10 /**< @brief NEW */
513#define MSG_FBGETVIEW 11 /**< @brief NEW */
514#define MSG_FBRMAP 12
515#define MSG_FBWMAP 13
516#define MSG_FBHELP 14
517#define MSG_FBREADRECT 15
518#define MSG_FBWRITERECT 16
519#define MSG_FBFLUSH 17
520#define MSG_FBFREE 18
521#define MSG_FBGETCURSOR 19 /**< @brief NEW */
522#define MSG_FBPOLL 30 /**< @brief NEW */
523#define MSG_FBSETCURSOR 31 /**< @brief NEW in Release 4.4 */
524#define MSG_FBBWREADRECT 32 /**< @brief NEW in Release 4.6 */
525#define MSG_FBBWWRITERECT 33 /**< @brief NEW in Release 4.6 */
527#define MSG_DATA 20
528#define MSG_RETURN 21
529#define MSG_CLOSE 22
530#define MSG_ERROR 23
532#define MSG_NORETURN 100
535
536#endif /* DM_H */
537
538/** @} */
539/*
540 * Local Variables:
541 * mode: C
542 * tab-width: 8
543 * indent-tabs-mode: t
544 * c-file-style: "stroustrup"
545 * End:
546 * ex: shiftwidth=4 tabstop=8
547 */
Header file for the BRL-CAD Numerical Computation Library, LIBBN.
Definition dvec.h:74
Header file for the BRL-CAD common definitions.
This header holds generic routines and data structures used for TCP based communication between a fra...
#define _BU_ATTR_PRINTF12
Definition defines.h:90
void int int * yp
Definition tig.h:209
void int float float float * scale
Definition tig.h:142
void int * xp
Definition tig.h:208
void float float * y
Definition tig.h:73
void int char * mode
Definition tig.h:179
void float float int int int int float * size
Definition tig.h:132
void float * x
Definition tig.h:72
long fb_poll_rate(struct fb *ifp)
int fb_reset(struct fb *ifp)
int dm_get_width(struct dm *dmp)
int dm_get_transparency(struct dm *dmp)
void * dm_get_ctx(struct dm *dmp)
int dm_set_hook(const struct bu_structparse_map *map, const char *key, void *data, struct dm_hook_data *hook)
unsigned char * dm_get_fg(struct dm *dmp)
int dm_get_stereo(struct dm *dmp)
int dm_event_cmp(struct dm *dmp, dm_event_t type, int event)
int fb_close(struct fb *ifp)
void fb_put(struct fb *ifp)
int fb_cursor(struct fb *ifp, int mode, int x, int y)
int dm_get_display_image(struct dm *dmp, unsigned char **image, int flip, int alpha)
int dm_free_dlists(struct dm *dmp, unsigned int list, int range)
void dm_set_fontsize(struct dm *dmp, int size)
unsigned long dm_get_id(struct dm *dmp)
int fb_bwwriterect(struct fb *ifp, int xmin, int ymin, int width, int height, const unsigned char *pp)
int dm_draw_obj(struct dm *dmp, struct bv_scene_obj *s)
int dm_get_linestyle(struct dm *dmp)
int dm_close(struct dm *dmp)
void dm_geometry_request(struct dm *dmp, int width, int height)
int dm_draw_point_2d(struct dm *dmp, fastf_t x, fastf_t y)
void dm_set_bound(struct dm *dmp, fastf_t val)
void dm_draw_rect(struct dm *dmp, struct bv_interactive_rect_state *grsp)
int dm_Normal2Xx(struct dm *dmp, fastf_t f)
int dm_get_zclip(struct dm *dmp)
void dm_set_vp(struct dm *dmp, fastf_t *vp)
void fb_log(const char *fmt,...) _BU_ATTR_PRINTF12
int fb_free(struct fb *ifp)
int dm_hud_begin(struct dm *dmp)
int dm_gen_dlists(struct dm *dmp, size_t range)
void dm_flush(struct dm *dmp)
const char * dm_graphics_system(const char *dmtype)
int fb_wmap(struct fb *ifp, const ColorMap *cmap)
fastf_t dm_Xy2Normal(struct dm *dmp, int y, int use_aspect)
int dm_draw_string_2d(struct dm *dmp, const char *str, fastf_t x, fastf_t y, int size, int use_aspect)
int dm_get_zbuffer(struct dm *dmp)
void dm_draw_hud_axes(struct dm *dmp, fastf_t viewSize, const mat_t rmat, struct bv_axes *bnasp)
int fb_view(struct fb *ifp, int xcenter, int ycenter, int xzoom, int yzoom)
const char * dm_get_dm_name(const struct dm *dmp)
const char * dm_init_msgs(void)
struct fb * fb_open_existing(const char *file, int _width, int _height, struct fb_platform_specific *fb_p)
int fb_is_set_fd(struct fb *ifp, fd_set *infds)
struct bu_structparse * dm_get_vparse(struct dm *dmp)
int fb_write_fp(struct fb *ifp, FILE *fp, int req_width, int req_height, int crunch, int inverse, struct bu_vls *result)
struct bu_vls * dm_get_pathname(struct dm *dmp)
int dm_end_dlist(struct dm *dmp)
const char * dm_bestXType(const char *dpy_string)
int dm_share_dlist(struct dm *dmp1, struct dm *dmp2)
int dm_set_bg(struct dm *dmp, unsigned char r1, unsigned char g1, unsigned char b1, unsigned char r2, unsigned char g2, unsigned char b2)
int dm_get_bound_flag(struct dm *dmp)
fastf_t dm_Xx2Normal(struct dm *dmp, int x)
struct dm * dm_open(void *ctx, void *interp, const char *type, int argc, const char *argv[])
void dm_draw_scale(struct dm *dmp, fastf_t viewSize, const char *unit, int *lineColor, int *textColor)
void fb_set_standalone(struct fb *ifp, int val)
const char * fb_version(void)
void dm_set_height(struct dm *dmp, int height)
int fb_window(struct fb *ifp, int xcenter, int ycenter)
void fb_make_linear_cmap(ColorMap *cmap)
int fb_null(struct fb *ifp)
void fb_put_platform_specific(struct fb_platform_specific *fb_p)
int dm_Normal2Xy(struct dm *dmp, fastf_t f, int use_aspect)
void dm_draw_adc(struct dm *dmp, struct bv_adc_state *adcp, mat_t view2model, mat_t model2view)
int dm_draw_vlist_hidden_line(struct dm *dmp, struct bv_vlist *vp)
void fb_setup_existing(struct fb *fbp, int _width, int _height, struct fb_platform_specific *fb_p)
int fb_setcursor(struct fb *ifp, const unsigned char *bits, int xb, int yb, int xo, int yo)
int dm_logfile(struct dm *dmp, const char *filename)
int dm_get_dirty(struct dm *dmp)
int dm_draw_line_2d(struct dm *dmp, fastf_t x1, fastf_t y1_2d, fastf_t x2, fastf_t y2)
int dm_draw_line_3d(struct dm *dmp, point_t pt1, point_t pt2)
int fb_writerect(struct fb *ifp, int xmin, int ymin, int width, int height, const unsigned char *pp)
int fb_clear(struct fb *ifp, unsigned char *pp)
struct dm * fb_get_dm(struct fb *ifp)
int dm_set_fg(struct dm *dmp, unsigned char r, unsigned char g, unsigned char b, int strict, fastf_t transparency)
int fb_common_image_size(size_t *widthp, size_t *heightp, size_t npixels)
int fb_read_fd(struct fb *ifp, int fd, int file_width, int file_height, int file_xoff, int file_yoff, int scr_width, int scr_height, int scr_xoff, int scr_yoff, int fileinput, char *file_name, int one_line_only, int multiple_lines, int autosize, int inverse, int clear, int zoom, struct bu_vls *result)
struct bu_vls * dm_get_tkname(struct dm *dmp)
int dm_set_zbuffer(struct dm *dmp, int zbuffer)
int fb_clear_fd(struct fb *ifp, fd_set *select_list)
ssize_t fb_read(struct fb *ifp, int x, int y, unsigned char *pp, size_t count)
int fb_viewport(struct fb *ifp, int left, int top, int right, int bottom)
int dm_doevent(struct dm *dmp, void *clientData, void *eventPtr)
int dm_draw_lines_3d(struct dm *dmp, int npoints, point_t *points, int sflag)
long fb_get_pagebuffer_pixel_size(struct fb *ifp)
vect_t * dm_get_clipmax(struct dm *dmp)
int dm_set_transparency(struct dm *dmp, int transparency)
void dm_set_linewidth(struct dm *dmp, int linewidth)
unsigned char RGBpixel[3]
Definition dm.h:358
int dm_graphical(const struct dm *dmp)
int dm_begin_dlist(struct dm *dmp, unsigned int list)
void dm_set_linestyle(struct dm *dmp, int linestyle)
int fb_configure_window(struct fb *, int, int)
int dm_set_depth_mask(struct dm *dmp, int d_on)
int dm_draw_begin(struct dm *dmp)
int dm_get_light(struct dm *dmp)
int dm_set_line_attr(struct dm *dmp, int width, int style)
int fb_seek(struct fb *ifp, int x, int y)
void * dm_interp(struct dm *dmp)
struct fb * fb_raw(const char *type)
const char * fb_get_name(const struct fb *ifp)
const char * dm_get_type(struct dm *dmp)
int fb_close_existing(struct fb *ifp)
int fb_tell(struct fb *ifp, int *xp, int *yp)
int fb_getview(struct fb *ifp, int *xcenter, int *ycenter, int *xzoom, int *yzoom)
int dm_draw_vlist(struct dm *dmp, struct bv_vlist *vp)
const char * dm_get_dm_lname(struct dm *dmp)
void dm_draw_data_axes(struct dm *dmp, fastf_t viewSize, struct bv_data_axes_state *bndasp)
void fb_set_magic(struct fb *ifp, uint32_t magic)
void dm_list_types(struct bu_vls *list, const char *separator)
int dm_loadpmatrix(struct dm *dmp, const fastf_t *mat)
int dm_get_fontsize(struct dm *dmp)
struct dm dm_null
void dm_draw_grid(struct dm *dmp, struct bv_grid_state *ggsp, fastf_t scale, mat_t model2view, fastf_t base2local)
int dm_make_current(struct dm *dmp)
struct bu_vls * dm_get_dname(struct dm *dmp)
int fb_help(struct fb *ifp)
int dm_get_linewidth(struct dm *dmp)
int dm_set_fb_visible(struct dm *dmp, int is_fb_visible)
int dm_hud_end(struct dm *dmp)
void dm_internal_var(struct bu_vls *result, struct dm *dmp, const char *key)
int fb_genhelp(void)
int dm_draw_point_3d(struct dm *dmp, point_t pt)
void dm_sync(struct dm *dmp)
int fb_get_max_width(struct fb *ifp)
fastf_t dm_get_aspect(struct dm *dmp)
int dm_get_perspective(struct dm *dmp)
struct fb * dm_get_fb(struct dm *dmp)
int fb_read_png(struct fb *ifp, FILE *fp_in, int file_xoff, int file_yoff, int scr_xoff, int scr_yoff, int clear, int zoom, int inverse, int one_line_only, int multiple_lines, int verbose, int header_only, double def_screen_gamma, struct bu_vls *result)
void dm_set_perspective(struct dm *dmp, fastf_t perspective)
struct fb * fb_open(const char *file, int _width, int _height)
int dm_processOptions(struct dm *dmp, struct bu_vls *init_proc_vls, int argc, const char **argv)
int fb_refresh(struct fb *ifp, int x, int y, int w, int h)
int dm_draw_end(struct dm *dmp)
int fb_scursor(struct fb *ifp, int mode, int x, int y)
void dm_set_width(struct dm *dmp, int width)
int fb_set_interface(struct fb *ifp, const char *interface_type)
int dm_draw_dlist(struct dm *dmp, unsigned int list)
const char * dm_get_name(const struct dm *dmp)
int dm_have_graphics(void)
int fb_ioinit(struct fb *ifp)
int fb_getheight(struct fb *ifp)
void dm_set_udata(struct dm *dmp, void *udata)
int fb_getcursor(struct fb *ifp, int *mode, int *x, int *y)
int vclip(point_t, point_t, fastf_t *, fastf_t *)
int fb_get_standalone(struct fb *ifp)
int fb_read_icv(struct fb *ifp, icv_image_t *img, int file_xoff, int file_yoff, int file_maxwidth, int file_maxheight, int scr_xoff, int scr_yoff, int clear, int zoom, int inverse, int one_line_only, int multiple_lines, struct bu_vls *result)
int fb_rpixel(struct fb *ifp, unsigned char *pp)
const char * dm_version(void)
int dm_draw_display_list(struct dm *dmp, struct display_list *obj)
void dm_fogHint(struct dm *dmp, int fastfog)
void dm_set_zclip(struct dm *dmp, int zclip)
int dm_get_debug(struct dm *dmp)
int clip(fastf_t *, fastf_t *, fastf_t *, fastf_t *)
int fb_poll(struct fb *ifp)
int fb_null_setcursor(struct fb *ifp, const unsigned char *bits, int xbits, int ybits, int xorig, int yorig)
int fb_common_file_size(size_t *widthp, size_t *heightp, const char *filename, int pixel_size)
int dm_set_debug(struct dm *dmp, int lvl)
int fb_common_name_size(size_t *widthp, size_t *heightp, const char *name)
int fb_flush(struct fb *ifp)
int fb_set_fd(struct fb *ifp, fd_set *select_list)
int fb_readrect(struct fb *ifp, int xmin, int ymin, int width, int height, unsigned char *pp)
int dm_get_bg(unsigned char **bg1, unsigned char **bg2, struct dm *dmp)
void dm_pop_pmatrix(struct dm *dmp)
int dm_set_light(struct dm *dmp, int light)
void dm_set_id(struct dm *dmp, unsigned long new_id)
int dm_reshape(struct dm *dmp, int width, int height)
struct fb * fb_get(void)
int dm_draw(struct dm *dmp, struct bv_vlist *(*callback)(void *), void **data)
int dm_draw_points_3d(struct dm *dmp, int npoints, point_t *points)
int dm_set_win_bounds(struct dm *dmp, fastf_t *w)
int dm_get_height(struct dm *dmp)
void dm_set_bound_flag(struct dm *dmp, int bound)
icv_image_t * fb_write_icv(struct fb *ifp, int scr_xoff, int scr_yoff, int width, int height)
void dm_draw_scene_axes(struct dm *dmp, struct bv_scene_obj *s)
const char * dm_default_type(void)
const char * fb_gettype(struct fb *ifp)
vect_t * dm_get_clipmin(struct dm *dmp)
void * dm_get_mvars(struct dm *dmp)
int fb_rmap(struct fb *ifp, ColorMap *cmap)
int dm_configure_win(struct dm *dmp, int force)
int dm_get_fb_visible(struct dm *dmp)
void * dm_get_udata(struct dm *dmp)
void dm_set_dirty(struct dm *dmp, int i)
int fb_get_max_height(struct fb *ifp)
int fb_is_linear_cmap(const ColorMap *cmap)
int dm_loadmatrix(struct dm *dmp, fastf_t *mat, int eye)
int dm_string_bbox_2d(struct dm *dmp, vect2d_t *bmin, vect2d_t *bmax, const char *str, fastf_t x, fastf_t y, int size, int use_aspect)
int dm_get_displaylist(struct dm *dmp)
const char * dm_get_graphics_system(const struct dm *dmp)
dm_event_t
Definition dm.h:308
int fb_wpixel(struct fb *ifp, unsigned char *pp)
int fb_zoom(struct fb *ifp, int xzoom, int yzoom)
ssize_t fb_write(struct fb *ifp, int x, int y, const unsigned char *pp, size_t count)
int dm_draw_head_dl(struct dm *dmp, struct bu_list *dl, fastf_t transparency_threshold, fastf_t inv_viewsize, short r, short g, short b, int line_width, int draw_style, int draw_edit, unsigned char *gdc, int solids_down, int mv_dlist)
struct fb_platform_specific * fb_get_platform_specific(uint32_t magic)
void dm_set_pathname(struct dm *dmp, const char *pname)
int fb_bwreadrect(struct fb *ifp, int xmin, int ymin, int width, int height, unsigned char *pp)
int dm_valid_type(const char *name, const char *dpy_string)
fastf_t dm_get_bound(struct dm *dmp)
int fb_getwidth(struct fb *ifp)
@ DM_BUTTON_PRESS
Definition dm.h:310
@ DM_BUTTON_RELEASE
Definition dm.h:311
@ DM_MOTION_NOTIFY
Definition dm.h:309
fastf_t vect_t[ELEMENTS_PER_VECT]
3-tuple vector
Definition vmath.h:349
fastf_t mat_t[ELEMENTS_PER_MAT]
4x4 matrix
Definition vmath.h:370
fastf_t point_t[ELEMENTS_PER_POINT]
3-tuple point
Definition vmath.h:355
fastf_t vect2d_t[ELEMENTS_PER_VECT2D]
2-tuple vector
Definition vmath.h:337
Global registry of recognized magic numbers.
Definition dm.h:366
Definition vls.h:53
void(* dm_hook)(const struct bu_structparse *, const char *, void *, const char *, void *)
Definition dm.h:76
void * dmh_data
Definition dm.h:77
Definition defines.h:62
struct dm_impl * i
Definition defines.h:64
uint32_t magic
Definition dm.h:462
Definition defines.h:75
Definition wdb.h:62
fundamental vector, matrix, quaternion math macros