rectangle.h File Reference

#include <libbase/libbase.h>
#include <stdint.h>
#include "element.h"

Include dependency graph for rectangle.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct _wlmtk_rectangle_t	wlmtk_rectangle_t

Functions
wlmtk_rectangle_t *	wlmtk_rectangle_create (int width, int height, uint32_t color)
void	wlmtk_rectangle_destroy (wlmtk_rectangle_t *rectangle_ptr)
void	wlmtk_rectangle_set_size (wlmtk_rectangle_t *rectangle_ptr, int width, int height)
void	wlmtk_rectangle_set_color (wlmtk_rectangle_t *rectangle_ptr, uint32_t color)
wlmtk_element_t *	wlmtk_rectangle_element (wlmtk_rectangle_t *rectangle_ptr)
wlmtk_rectangle_t *	wlmtk_rectangle_from_element (wlmtk_element_t *element_ptr)

Variables
const bs_test_case_t	wlmtk_rectangle_test_cases []

Detailed Description

Copyright

Copyright 2023 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

wlmtk_rectangle_t

typedef struct _wlmtk_rectangle_t wlmtk_rectangle_t

Forward declaration: Rectangle state.

Function Documentation

wlmtk_rectangle_create()

wlmtk_rectangle_t * wlmtk_rectangle_create	(	int	width,
		int	height,
		uint32_t	color
	)

Creates a rectangle. Useful for margins and borders.

Parameters

width
height
color

Returns

Pointer to the rectangle state or NULL on error.

wlmtk_rectangle_destroy()

void wlmtk_rectangle_destroy

(

wlmtk_rectangle_t *

rectangle_ptr

)

Destroys the rectangle.

Parameters

rectangle_ptr

wlmtk_rectangle_element()

wlmtk_element_t * wlmtk_rectangle_element

(

wlmtk_rectangle_t *

rectangle_ptr

)

Returns the superclass wlmtk_element_t of the rectangle.

wlmtk_rectangle_from_element()

wlmtk_rectangle_t * wlmtk_rectangle_from_element

(

wlmtk_element_t *

element_ptr

)

Gets the wlmtk_rectangle_t instance from it's element superclass.

Requires element_ptr as pointer to wlmtk_rectangle_t::super_element.

Parameters

element_ptr

Returns

The pointer to the wlmtk_rectangle_t instance.

wlmtk_rectangle_set_color()

void wlmtk_rectangle_set_color	(	wlmtk_rectangle_t *	rectangle_ptr,
		uint32_t	color
	)

Sets (or updates) the color of the rectangle.

Parameters

rectangle_ptr
color

wlmtk_rectangle_set_size()

void wlmtk_rectangle_set_size	(	wlmtk_rectangle_t *	rectangle_ptr,
		int	width,
		int	height
	)

Sets (or updates) the size of the rectangle.

Parameters

rectangle_ptr
width
height

Variable Documentation

wlmtk_rectangle_test_cases

const bs_test_case_t wlmtk_rectangle_test_cases[]

extern

Unit tests.