xil_kernel_get_height(3)

NAME

xil_kernel_get_height, xil_kernel_get_width, xil_kernel_get_key_x, xil_kernel_get_key_y − read attributes of kernels

SYNOPSIS

#include <xil/xil.h>

unsigned int xil_kernel_get_height (XilKernel kernel);

unsigned int xil_kernel_get_width (XilKernel kernel);

unsigned int xil_kernel_get_key_x (XilKernel kernel);

unsigned int xil_kernel_get_key_y (XilKernel kernel);

DESCRIPTION

These routines read the attributes of XilKernel kernel objects. Kernels are used in image convolution, error diffusion, painting, and band combine operations. The key values specify the key pixel position - a position relative to the upper left corner of the kernel. The key pixel aligns with the output pixel and constrains which input pixels are used to generate the output.

xil_kernel_get_height() gets the height of a kernel.

xil_kernel_get_width() gets the width of a kernel.

xil_kernel_get_key_x() gets the x coordinate of the key value of the specified kernel.

xil_kernel_get_key_y() gets the y coordinate of the key value of the specified kernel.

ERRORS

For a complete list of XIL error messages by number, consult Appendix B of the XIL Programmer’s Guide.

EXAMPLES

Get the coordinates of a kernel’s key value:

XilKernel kernel;
unsigned int key_x, key_y;
key_x = xil_kernel_get_key_x (kernel);
key_y = xil_kernel_get_key_y (kernel);

Museum