libetherpix

include/flexipix/display.h   1) /*

include/etherpix/display.h   2)  * EtherPix library

include/flexipix/display.h   3)  *

include/flexipix/display.h   4)  * Copyright 2010-2011 Stefan Schuermans <stefan schuermans info>

include/flexipix/display.h   5)  *
include/flexipix/display.h   6)  * This program is free software: you can redistribute it and/or modify
include/flexipix/display.h   7)  * it under the terms of the GNU General Public License as published by
include/flexipix/display.h   8)  * the Free Software Foundation, version 3 of the License.
include/flexipix/display.h   9)  *
include/flexipix/display.h  10)  *
include/flexipix/display.h  11)  * This program is distributed in the hope that it will be useful,
include/flexipix/display.h  12)  * but WITHOUT ANY WARRANTY; without even the implied warranty of
include/flexipix/display.h  13)  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
include/flexipix/display.h  14)  * GNU General Public License for more details.
include/flexipix/display.h  15)  *
include/flexipix/display.h  16)  * You should have received a copy of the GNU Lesser General Public License
include/flexipix/display.h  17)  * along with this program. If not, see <http://www.gnu.org/licenses/>.
include/flexipix/display.h  18)  */
include/flexipix/display.h  19) 

include/etherpix/display.h  20) #ifndef ETP_INC_DISPLAY_H
include/etherpix/display.h  21) #define ETP_INC_DISPLAY_H

include/flexipix/display.h  22) 

include/etherpix/display.h  23) #include <etherpix/msg.h>
include/etherpix/display.h  24) #include <etherpix/types.h>

include/flexipix/display.h  25) 
include/flexipix/display.h  26) /**

include/etherpix/display.h  27)  * \brief create a new EtherPix display

include/flexipix/display.h  28)  *
include/flexipix/display.h  29)  * \param[in] sz_config_file name of config file to read
include/flexipix/display.h  30)  * \param[in] p_msg_func message callback function or NULL
include/flexipix/display.h  31)  * \param[in] p_msg_ctx user context for message callback

include/etherpix/display.h  32)  * \return pointer to new EtherPix display on success

include/flexipix/display.h  33)  *         or NULL on error
include/flexipix/display.h  34)  */

include/etherpix/display.h  35) etp_display_t *etp_display_create(const char *sz_config_file,
include/etherpix/display.h  36)                                   etp_msg_func_p_t p_msg_func,

include/flexipix/display.h  37)                                   void *p_msg_ctx);
include/flexipix/display.h  38) 
include/flexipix/display.h  39) /**

include/etherpix/display.h  40)  * \brief free a EtherPix display

include/flexipix/display.h  41)  *

include/etherpix/display.h  42)  * \param[in] p_display pointer to EtherPix display

include/flexipix/display.h  43)  */

include/etherpix/display.h  44) void etp_display_free(etp_display_t *p_display);

include/flexipix/display.h  45) 
include/flexipix/display.h  46) /**
include/flexipix/display.h  47)  * \brief get size of display
include/flexipix/display.h  48)  *

include/etherpix/display.h  49)  * \param[in] p_display pointer to EtherPix display

include/flexipix/display.h  50)  * \param[out] p_width width of display
include/flexipix/display.h  51)  * \param[out] p_height height of display
include/flexipix/display.h  52)  */

include/etherpix/display.h  53) void etp_display_get_size(etp_display_t *p_display,

include/flexipix/display.h  54)                           unsigned int *p_width, unsigned int *p_height);
include/flexipix/display.h  55) 
include/flexipix/display.h  56) /**

include/etherpix/display.h  57)  * \brief clear image data to output on EtherPix display

include/flexipix/display.h  58)  *
include/flexipix/display.h  59)  * clears the stored image data,
include/flexipix/display.h  60)  * stored image data can later be sent to the distributors using

include/etherpix/display.h  61)  * etp_display_send()

include/flexipix/display.h  62)  *

include/etherpix/display.h  63)  * \param[in] p_display pointer to EtherPix display

include/flexipix/display.h  64)  */

include/etherpix/display.h  65) void etp_display_data_clear(etp_display_t *p_display);

include/flexipix/display.h  66) 
include/flexipix/display.h  67) /**

include/etherpix/display.h  68)  * \brief set image data to output on EtherPix display

include/flexipix/display.h  69)  *
include/flexipix/display.h  70)  * updates (part of) the stored image data,
include/flexipix/display.h  71)  * stored image data can later be sent to the distributors using

include/etherpix/display.h  72)  * etp_display_send()

include/flexipix/display.h  73)  *

include/etherpix/display.h  74)  * \param[in] p_display pointer to EtherPix display

include/flexipix/display.h  75)  * \param[in] p_data pointer to rectangular section of image data

include/flexipix/display.h  76)  * \param[in] stride_x stride between two pixels in X direction
include/flexipix/display.h  77)  * \param[in] stride_y stride between two pixels in Y direction
include/flexipix/display.h  78)  * \param[in] x X coordinate of left side of rectangular area
include/flexipix/display.h  79)  * \param[in] y Y coordinate of top side of rectangular area
include/flexipix/display.h  80)  * \param[in] width with of rectangular area
include/flexipix/display.h  81)  * \param[in] height height of rectangular area

include/flexipix/display.h  82)  * \param[in] pixfmt format of pixel data
include/flexipix/display.h  83)  */

include/etherpix/display.h  84) void etp_display_data_fmt(etp_display_t *p_display, etp_u8_t *p_data,

include/flexipix/display.h  85)                           int stride_x, int stride_y,
include/flexipix/display.h  86)                           unsigned int x, unsigned int y,
include/flexipix/display.h  87)                           unsigned int width, unsigned int height,

include/etherpix/display.h  88)                           etp_pixfmt_t pixfmt);

include/flexipix/display.h  89) 
include/flexipix/display.h  90) /**

include/etherpix/display.h  91)  * \brief set image data to output on EtherPix display

include/flexipix/display.h  92)  *

include/etherpix/display.h  93)  * see etp_display_data_fmt for documentation
include/etherpix/display.h  94)  * pixfmt is fixed to etp_pixfmt_rgb24

include/flexipix/display.h  95)  */

include/etherpix/display.h  96) void etp_display_data(etp_display_t *p_display, etp_u8_t *p_data,

include/flexipix/display.h  97)                       int stride_x, int stride_y,
include/flexipix/display.h  98)                       unsigned int x, unsigned int y,
include/flexipix/display.h  99)                       unsigned int width, unsigned int height);
include/flexipix/display.h 100) 
include/flexipix/display.h 101) /**
include/flexipix/display.h 102)  * \brief send image data to distributors
include/flexipix/display.h 103)  *
include/flexipix/display.h 104)  * sends the currently stored image data to all configured distributors
include/flexipix/display.h 105)  *

include/etherpix/display.h 106)  * \param[in] p_display pointer to EtherPix display

include/flexipix/display.h 107)  */

include/etherpix/display.h 108) void etp_display_send(etp_display_t *p_display);

include/flexipix/display.h 109) 

include/etherpix/display.h 110) #endif /* #ifndef ETP_INC_DISPLAY_H */