X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b737ad10dec946cd7d5e38c43c666e8efe89f0ae..f98488c8ca626661a4f414bdf38f45254fecb03e:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index 379ce7fb72..9cf68bb2a0 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -98,7 +98,7 @@ and forth without loss in that respect. Creates an image with the given width and height. If {\it clear} is true, the new image will be initialized to black. Otherwise, the image data will be uninitialized. -\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static\_data=false}} +\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static\_data = \false}} Creates an image from given data with the given width and height. If {\it static\_data} is true, then wxImage will not delete the actual @@ -270,7 +270,7 @@ Returns number of colours in the histogram. \membersection{wxImage::ConvertAlphaToMask}\label{wximageconvertalphatomask} -\func{bool}{ConvertAlphaToMask}{\param{unsigned char}{ threshold = 128}} +\func{bool}{ConvertAlphaToMask}{\param{unsigned char}{ threshold = $128$}} If the image has alpha channel, this method converts it to mask. All pixels with alpha value less than \arg{threshold} are replaced with mask colour @@ -708,6 +708,15 @@ of a given handler class in an application session.} \helpref{wxImageHandler}{wximagehandler} +\membersection{wxImage::IsTransparent}\label{wximageistransparent} + +\constfunc{bool}{IsTransparent}{\param{int }{x}, \param{int }{y}, \param{unsigned char}{ threshold = $128$}} + +Returns \true if the given pixel is transparent, i.e. either has the mask +colour if this image has a mask or if this image has alpha channel and alpha +value of this pixel is strictly less than \arg{threshold}. + + \membersection{wxImage::LoadFile}\label{wximageloadfile} \func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}, \param{int}{ index = -1}} @@ -1023,14 +1032,16 @@ suitable mask colour for any newly exposed areas. \membersection{wxImage::SetAlpha}\label{wximagesetalpha} -\func{void}{SetAlpha}{\param{unsigned char *}{alpha = {\tt NULL}}} +\func{void}{SetAlpha}{\param{unsigned char *}{alpha = {\tt NULL}},\param{bool}{ static\_data = \false}} This function is similar to \helpref{SetData}{wximagesetdata} and has similar restrictions. The pointer passed to it may however be {\tt NULL} in which case the function will allocate the alpha array internally -- this is useful to add alpha channel data to an image which doesn't have any. If the pointer is not {\tt NULL}, it must have one byte for each image pixel and be allocated with -{\tt malloc()}. wxImage takes ownership of the pointer and will free it. +{\tt malloc()}. wxImage takes ownership of the pointer and will free it unless +\arg{static\_data} parameter is set.to \true -- in this case the caller should +do it. \func{void}{SetAlpha}{\param{int }{x}, \param{int }{y}, \param{unsigned char }{alpha}}