libetherpix

include/flexipix/displayer.h   1) /*

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

include/flexipix/displayer.h   3)  *

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

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

include/etherpix/displayer.h  20) #ifndef ETP_INC_DISPLAYER_H
include/etherpix/displayer.h  21) #define ETP_INC_DISPLAYER_H

include/flexipix/displayer.h  22) 

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

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

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

include/flexipix/displayer.h  28)  *
include/flexipix/displayer.h  29)  * A displayer manages a display and ensures that a the current
include/flexipix/displayer.h  30)  * image data is sent often enough to the distributors so
include/flexipix/displayer.h  31)  * that the pixels do detect a timeout and turn off automatically.
include/flexipix/displayer.h  32)  * The displayer uses a thread to do this.
include/flexipix/displayer.h  33)  * Initially, the new displayer is inactive and has to be activated

include/etherpix/displayer.h  34)  * using etp_displayer_activate().

include/flexipix/displayer.h  35)  *
include/flexipix/displayer.h  36)  * \param[in] sz_config_file name of config file to read
include/flexipix/displayer.h  37)  * \param[in] p_msg_func message callback function or NULL
include/flexipix/displayer.h  38)  * \param[in] p_msg_ctx user context for message callback

include/etherpix/displayer.h  39)  * \return pointer to new EtherPix displayer on success

include/flexipix/displayer.h  40)  *         or NULL on error
include/flexipix/displayer.h  41)  */

include/etherpix/displayer.h  42) etp_displayer_t *etp_displayer_create(const char *sz_config_file,
include/etherpix/displayer.h  43)                                       etp_msg_func_p_t p_msg_func,

include/flexipix/displayer.h  44)                                       void *p_msg_ctx);
include/flexipix/displayer.h  45) 
include/flexipix/displayer.h  46) /**

include/etherpix/displayer.h  47)  * \brief free a EtherPix displayer

include/flexipix/displayer.h  48)  *

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

include/flexipix/displayer.h  50)  */

include/etherpix/displayer.h  51) void etp_displayer_free(etp_displayer_t *p_displayer);

include/flexipix/displayer.h  52) 
include/flexipix/displayer.h  53) /**
include/flexipix/displayer.h  54)  * \brief get size of display managed by displayer
include/flexipix/displayer.h  55)  *

include/etherpix/displayer.h  56)  * \param[in] p_displayer pointer to EtherPix displayer

include/flexipix/displayer.h  57)  * \param[out] p_width width of display
include/flexipix/displayer.h  58)  * \param[out] p_height height of display
include/flexipix/displayer.h  59)  */

include/etherpix/displayer.h  60) void etp_displayer_get_size(etp_displayer_t *p_displayer,

include/flexipix/displayer.h  61)                             unsigned int *p_width, unsigned int *p_height);
include/flexipix/displayer.h  62) 
include/flexipix/displayer.h  63) /**
include/flexipix/displayer.h  64)  * \brief activate the displayer
include/flexipix/displayer.h  65)  *
include/flexipix/displayer.h  66)  * set the displayer to active, i.e. make it send image data
include/flexipix/displayer.h  67)  * to the distributors automatically,
include/flexipix/displayer.h  68)  * this function might trigger sending of data if the last
include/flexipix/displayer.h  69)  * sending time was too long ago
include/flexipix/displayer.h  70)  *

include/etherpix/displayer.h  71)  * \param[in] p_displayer pointer to EtherPix displayer

include/flexipix/displayer.h  72)  */

include/etherpix/displayer.h  73) void etp_displayer_activate(etp_displayer_t *p_displayer);

include/flexipix/displayer.h  74) 
include/flexipix/displayer.h  75) /**
include/flexipix/displayer.h  76)  * \brief deactivate the displayer
include/flexipix/displayer.h  77)  *
include/flexipix/displayer.h  78)  * set the displayer to deactive, i.e. prevent it from sening image
include/flexipix/displayer.h  79)  * data to the distributors automatically,
include/flexipix/displayer.h  80)  *

include/etherpix/displayer.h  81)  * \param[in] p_displayer pointer to EtherPix displayer

include/flexipix/displayer.h  82)  */

include/etherpix/displayer.h  83) void etp_displayer_deactivate(etp_displayer_t *p_displayer);

include/flexipix/displayer.h  84) 
include/flexipix/displayer.h  85) /**

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

include/flexipix/displayer.h  87)  *
include/flexipix/displayer.h  88)  * clears the stored image data
include/flexipix/displayer.h  89)  *

include/etherpix/displayer.h  90)  * \param[in] p_displayer pointer to EtherPix displayer

include/flexipix/displayer.h  91)  */

include/etherpix/displayer.h  92) void etp_displayer_data_clear(etp_displayer_t *p_displayer);

include/flexipix/displayer.h  93) 
include/flexipix/displayer.h  94) /**

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

include/flexipix/displayer.h  96)  *
include/flexipix/displayer.h  97)  * updates (part of) the stored image data
include/flexipix/displayer.h  98)  *

include/etherpix/displayer.h  99)  * \param[in] p_displayer pointer to EtherPix displayer

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

include/flexipix/displayer.h 101)  * \param[in] stride_x stride between two pixels in X direction
include/flexipix/displayer.h 102)  * \param[in] stride_y stride between two pixels in Y direction
include/flexipix/displayer.h 103)  * \param[in] x X coordinate of left side of rectangular area
include/flexipix/displayer.h 104)  * \param[in] y Y coordinate of top side of rectangular area
include/flexipix/displayer.h 105)  * \param[in] width with of rectangular area
include/flexipix/displayer.h 106)  * \param[in] height height of rectangular area

include/flexipix/displayer.h 107)  * \param[in] pixfmt format of pixel data
include/flexipix/displayer.h 108)  */

include/etherpix/displayer.h 109) void etp_displayer_data_fmt(etp_displayer_t *p_displayer, etp_u8_t *p_data,

include/flexipix/displayer.h 110)                             int stride_x, int stride_y,
include/flexipix/displayer.h 111)                             unsigned int x, unsigned int y,
include/flexipix/displayer.h 112)                             unsigned int width, unsigned int height,

include/etherpix/displayer.h 113)                             etp_pixfmt_t pixfmt);

include/flexipix/displayer.h 114) 
include/flexipix/displayer.h 115) /**

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

include/flexipix/displayer.h 117)  *

include/etherpix/displayer.h 118)  * see etp_displayer_data_fmt for documentation
include/etherpix/displayer.h 119)  * pixfmt is fixed to etp_pixfmt_rgb24

include/flexipix/displayer.h 120)  */

include/etherpix/displayer.h 121) void etp_displayer_data(etp_displayer_t *p_displayer, etp_u8_t *p_data,

include/flexipix/displayer.h 122)                         int stride_x, int stride_y,
include/flexipix/displayer.h 123)                         unsigned int x, unsigned int y,
include/flexipix/displayer.h 124)                         unsigned int width, unsigned int height);
include/flexipix/displayer.h 125) 
include/flexipix/displayer.h 126) /**
include/flexipix/displayer.h 127)  * \brief trigger immediate sending of new image data to distributors
include/flexipix/displayer.h 128)  *
include/flexipix/displayer.h 129)  * this only works if the displayer is active
include/flexipix/displayer.h 130)  *

include/etherpix/displayer.h 131)  * \param[in] p_displayer pointer to EtherPix displayer

include/flexipix/displayer.h 132)  */

include/etherpix/displayer.h 133) void etp_displayer_send(etp_displayer_t *p_displayer);

include/flexipix/displayer.h 134) 

include/etherpix/displayer.h 135) #endif /* #ifndef ETP_INC_DISPLAYER_H */