LWJGL 3.3.3 · org.lwjgl.opencl.IMGGenerateMipmap

Modifier and Type	Field and Description
public static final int	CL_COMMAND_GENERATE_MIPMAP_IMG New command types cl_command_type.
public static final int	CL_MIPMAP_FILTER_ANY_IMG Values accepted with cl_mipmap_filter_mode_img.
public static final int	CL_MIPMAP_FILTER_BOX_IMG Values accepted with cl_mipmap_filter_mode_img.

Access	Constructor and Description
protected	IMGGenerateMipmap()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public static int	clEnqueueGenerateMipmapIMG(long a valid command-queue command_queue, long a valid 1D, 2D, 3D image or a 1D image array, 2D image array object src_image, long a valid 1D, 2D, 3D image or a 1D image array, 2D image array object dst_image, int the filter mode to generate the mipmap levels with mipmap_filter_mode, PointerBuffer the `(n,m)` image range in a 1D and 2D image array to generate array_region, PointerBuffer the `(n,m)` region of mipmap levels to generate in `dst_image` mip_region, PointerBuffer a list of events that need to complete before this particular command can be executed. If `event_wait_list` is `NULL`, then this particular command does not wait on any event to complete. The events specified in `event_wait_list` act as synchronization points. The context associated with events in `event_wait_list` and `command_queue` must be the same. event_wait_list, PointerBuffer Returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete. `event` can be `NULL` in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. If the `event_wait_list` and the `event` arguments are not `NULL`, the event argument should not refer to an element of the `event_wait_list` array. event) Generates mipmap levels from a source image to a destination image.
public static int	nclEnqueueGenerateMipmapIMG(long command_queue, long src_image, long dst_image, int mipmap_filter_mode, long array_region, long mip_region, int the number of events in `event_wait_list` num_events_in_wait_list, long event_wait_list, long event) Unsafe version of: `EnqueueGenerateMipmapIMG`

public static int

clEnqueueGenerateMipmapIMG(long

a valid command-queue

command_queue, long

a valid 1D, 2D, 3D image or a 1D image array, 2D image array object

src_image, long

a valid 1D, 2D, 3D image or a 1D image array, 2D image array object

dst_image, int

the filter mode to generate the mipmap levels with

mipmap_filter_mode, PointerBuffer

the (n,m) image range in a 1D and 2D image array to generate

array_region, PointerBuffer

the (n,m) region of mipmap levels to generate in dst_image

mip_region, PointerBuffer

a list of events that need to complete before this particular command can be executed. If event_wait_list is NULL, then this particular command does not wait on any event to complete. The events specified in event_wait_list act as synchronization points. The context associated with events in event_wait_list and command_queue must be the same.

event_wait_list, PointerBuffer

Returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete. event can be NULL in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. If the event_wait_list and the event arguments are not NULL, the event argument should not refer to an element of the event_wait_list array.

event)

Generates mipmap levels from a source image to a destination image.

public static int

nclEnqueueGenerateMipmapIMG(long command_queue, long src_image, long dst_image, int mipmap_filter_mode, long array_region, long mip_region, int

the number of events in event_wait_list

num_events_in_wait_list, long event_wait_list, long event)

Unsafe version of: EnqueueGenerateMipmapIMG

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

CL_COMMAND_GENERATE_MIPMAP_IMG	back to summary
public static final int CL_COMMAND_GENERATE_MIPMAP_IMG New command types cl_command_type.

CL_MIPMAP_FILTER_ANY_IMG	back to summary
public static final int CL_MIPMAP_FILTER_ANY_IMG Values accepted with cl_mipmap_filter_mode_img.

CL_MIPMAP_FILTER_BOX_IMG	back to summary
public static final int CL_MIPMAP_FILTER_BOX_IMG Values accepted with cl_mipmap_filter_mode_img.

IMGGenerateMipmap	back to summary
protected IMGGenerateMipmap()

Method Detail

clEnqueueGenerateMipmapIMG back to summary

clEnqueueGenerateMipmapIMG	back to summary
public static int clEnqueueGenerateMipmapIMG(long command_queue, long src_image, long dst_image, int mipmap_filter_mode, PointerBuffer array_region, PointerBuffer mip_region, PointerBuffer event_wait_list, PointerBuffer event) Generates mipmap levels from a source image to a destination image. This allows for seamless mipmap level generation without involving the host to generate them, as that would involve reading back the image, generate its mipmap levels and then upload it to the device again. This reduces bandwidth cost of generating mipmap levels as no host copy is needed and may improve the speed of generating mipmap levels. The source image and destination image can be the same image in order to reduce programming and memory overhead. As with the extension for mipmaps, the size of the image must be a power of 2. Parameters command_queue:long a valid command-queue src_image:long a valid 1D, 2D, 3D image or a 1D image array, 2D image array object dst_image:long a valid 1D, 2D, 3D image or a 1D image array, 2D image array object mipmap_filter_mode:int the filter mode to generate the mipmap levels with array_region:PointerBuffer the `(n,m)` image range in a 1D and 2D image array to generate mip_region:PointerBuffer the `(n,m)` region of mipmap levels to generate in `dst_image` event_wait_list:PointerBuffer a list of events that need to complete before this particular command can be executed. If `event_wait_list` is `NULL`, then this particular command does not wait on any event to complete. The events specified in `event_wait_list` act as synchronization points. The context associated with events in `event_wait_list` and `command_queue` must be the same. event:PointerBuffer Returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete. `event` can be `NULL` in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. If the `event_wait_list` and the `event` arguments are not `NULL`, the event argument should not refer to an element of the `event_wait_list` array. Annotations @NativeType:cl_int

public static int clEnqueueGenerateMipmapIMG(long command_queue, long src_image, long dst_image, int mipmap_filter_mode, PointerBuffer array_region, PointerBuffer mip_region, PointerBuffer event_wait_list, PointerBuffer event)

Generates mipmap levels from a source image to a destination image.

This allows for seamless mipmap level generation without involving the host to generate them, as that would involve reading back the image, generate its mipmap levels and then upload it to the device again. This reduces bandwidth cost of generating mipmap levels as no host copy is needed and may improve the speed of generating mipmap levels. The source image and destination image can be the same image in order to reduce programming and memory overhead. As with the extension for mipmaps, the size of the image must be a power of 2.

Parameters

command_queue:long: a valid command-queue
src_image:long: a valid 1D, 2D, 3D image or a 1D image array, 2D image array object
dst_image:long: a valid 1D, 2D, 3D image or a 1D image array, 2D image array object
mipmap_filter_mode:int: the filter mode to generate the mipmap levels with
array_region:PointerBuffer: the (n,m) image range in a 1D and 2D image array to generate
mip_region:PointerBuffer: the (n,m) region of mipmap levels to generate in dst_image
event_wait_list:PointerBuffer: a list of events that need to complete before this particular command can be executed. If event_wait_list is NULL, then this particular command does not wait on any event to complete. The events specified in event_wait_list act as synchronization points. The context associated with events in event_wait_list and command_queue must be the same.
event:PointerBuffer: Returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete. event can be NULL in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. If the event_wait_list and the event arguments are not NULL, the event argument should not refer to an element of the event_wait_list array.

Annotations

@NativeType:cl_int

nclEnqueueGenerateMipmapIMG back to summary

nclEnqueueGenerateMipmapIMG	back to summary
public static int nclEnqueueGenerateMipmapIMG(long command_queue, long src_image, long dst_image, int mipmap_filter_mode, long array_region, long mip_region, int num_events_in_wait_list, long event_wait_list, long event) Unsafe version of: `EnqueueGenerateMipmapIMG` Parameters num_events_in_wait_list:int the number of events in `event_wait_list`

public static int nclEnqueueGenerateMipmapIMG(long command_queue, long src_image, long dst_image, int mipmap_filter_mode, long array_region, long mip_region, int num_events_in_wait_list, long event_wait_list, long event)

Unsafe version of: EnqueueGenerateMipmapIMG

Parameters

num_events_in_wait_list:int: the number of events in event_wait_list

public Class IMGGenerateMipmap

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail